Java Doc for Reader.java in  » 6.0-JDK-Core » io-nio » java » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » io nio » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.Reader

All known Subclasses:   java.io.PipedReader,  java.io.FilterReader,  java.io.CharArrayReader,  java.io.StringReader,  java.io.InputStreamReader,  java.io.BufferedReader,
Reader
abstract public class Reader implements Readable,Closeable(Code)
Abstract class for reading character streams. The only methods that a subclass must implement are read(char[], int, int) and close(). Most subclasses, however, will override some of the methods defined here in order to provide higher efficiency, additional functionality, or both.
See Also:   BufferedReader
See Also:   LineNumberReader
See Also:   CharArrayReader
See Also:   InputStreamReader
See Also:   FileReader
See Also:   FilterReader
See Also:   PushbackReader
See Also:   PipedReader
See Also:   StringReader
See Also:   Writer
version:
   1.36, 07/05/05
author:
   Mark Reinhold
since:
   JDK1.1


Field Summary
protected  Objectlock
     The object used to synchronize operations on this stream.

Constructor Summary
protected  Reader()
     Creates a new character-stream reader whose critical sections will synchronize on the reader itself.
protected  Reader(Object lock)
     Creates a new character-stream reader whose critical sections will synchronize on the given object.

Method Summary
abstract public  voidclose()
     Closes the stream and releases any system resources associated with it.
public  voidmark(int readAheadLimit)
     Marks the present position in the stream.
public  booleanmarkSupported()
     Tells whether this stream supports the mark() operation.
public  intread(java.nio.CharBuffer target)
     Attempts to read characters into the specified character buffer. The buffer is used as a repository of characters as-is: the only changes made are the results of a put operation.
public  intread()
     Reads a single character.
public  intread(char cbuf)
     Reads characters into an array.
abstract public  intread(char cbuf, int off, int len)
     Reads characters into a portion of an array.
public  booleanready()
     Tells whether this stream is ready to be read. True if the next read() is guaranteed not to block for input,false otherwise.
public  voidreset()
     Resets the stream.
public  longskip(long n)
     Skips characters.

Field Detail
lock
protected Object lock(Code)
The object used to synchronize operations on this stream. For efficiency, a character-stream object may use an object other than itself to protect critical sections. A subclass should therefore use the object in this field rather than this or a synchronized method.




Constructor Detail
Reader
protected Reader()(Code)
Creates a new character-stream reader whose critical sections will synchronize on the reader itself.



Reader
protected Reader(Object lock)(Code)
Creates a new character-stream reader whose critical sections will synchronize on the given object.
Parameters:
  lock - The Object to synchronize on.




Method Detail
close
abstract public void close() throws IOException(Code)
Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.
exception:
  IOException - If an I/O error occurs



mark
public void mark(int readAheadLimit) throws IOException(Code)
Marks the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point. Not all character-input streams support the mark() operation.
Parameters:
  readAheadLimit - Limit on the number of characters that may beread while still preserving the mark. Afterreading this many characters, attempting toreset the stream may fail.
exception:
  IOException - If the stream does not support mark(),or if some other I/O error occurs



markSupported
public boolean markSupported()(Code)
Tells whether this stream supports the mark() operation. The default implementation always returns false. Subclasses should override this method. true if and only if this stream supports the mark operation.



read
public int read(java.nio.CharBuffer target) throws IOException(Code)
Attempts to read characters into the specified character buffer. The buffer is used as a repository of characters as-is: the only changes made are the results of a put operation. No flipping or rewinding of the buffer is performed.
Parameters:
  target - the buffer to read characters into The number of characters added to the buffer, or -1 if this source of characters is at its end
throws:
  IOException - if an I/O error occurs
throws:
  NullPointerException - if target is null
throws:
  ReadOnlyBufferException - if target is a read only buffer
since:
   1.5



read
public int read() throws IOException(Code)
Reads a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached.

Subclasses that intend to support efficient single-character input should override this method. The character read, as an integer in the range 0 to 65535(0x00-0xffff), or -1 if the end of the stream hasbeen reached
exception:
  IOException - If an I/O error occurs




read
public int read(char cbuf) throws IOException(Code)
Reads characters into an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.
Parameters:
  cbuf - Destination buffer The number of characters read, or -1 if the end of the streamhas been reached
exception:
  IOException - If an I/O error occurs



read
abstract public int read(char cbuf, int off, int len) throws IOException(Code)
Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.
Parameters:
  cbuf - Destination buffer
Parameters:
  off - Offset at which to start storing characters
Parameters:
  len - Maximum number of characters to read The number of characters read, or -1 if the end of thestream has been reached
exception:
  IOException - If an I/O error occurs



ready
public boolean ready() throws IOException(Code)
Tells whether this stream is ready to be read. True if the next read() is guaranteed not to block for input,false otherwise. Note that returning false does not guarantee that thenext read will block.
exception:
  IOException - If an I/O error occurs



reset
public void reset() throws IOException(Code)
Resets the stream. If the stream has been marked, then attempt to reposition it at the mark. If the stream has not been marked, then attempt to reset it in some way appropriate to the particular stream, for example by repositioning it to its starting point. Not all character-input streams support the reset() operation, and some support reset() without supporting mark().
exception:
  IOException - If the stream has not been marked,or if the mark has been invalidated,or if the stream does not support reset(),or if some other I/O error occurs



skip
public long skip(long n) throws IOException(Code)
Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached.
Parameters:
  n - The number of characters to skip The number of characters actually skipped
exception:
  IllegalArgumentException - If n is negative.
exception:
  IOException - If an I/O error occurs



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.