Android - An Open Handset Alliance Project

java.io.Reader

Android - An Open Handset Alliance Project

Documentation

Roadmap

Goodies

java.io.Reader

Summary

Details

Summary

Details

Fields

Protected Constructors

Public Methods

Fields

Protected Constructors

Public Methods

Fields

Protected Constructors

Public Methods

Fields

Protected Constructors

Public Methods

protected Object lock

protected Reader()

protected Reader(Object lock)

Parameters

public abstract void close()

Throws

public void mark(int readLimit)

Parameters

Throws

public boolean markSupported()

Returns

public abstract int read(char[] buf, int offset, int count)

Parameters

Returns

Throws

public int read(CharBuffer target)

Parameters

Returns

Throws

public int read(char[] buf)

Parameters

Returns

Throws

public int read()

Returns

Throws

public boolean ready()

Returns

Throws

public void reset()

Throws

public long skip(long count)

Parameters

Returns

Throws

See Also

protected Object lock

protected Reader()

protected Reader(Object lock)

Parameters

public abstract void close()

Throws

public void mark(int readLimit)

Parameters

Throws

public boolean markSupported()

Returns

public abstract int read(char[] buf, int offset, int count)

Parameters

Returns

Throws

public int read(CharBuffer target)

Parameters

Returns

Throws

public int read(char[] buf)

Parameters

Returns

Throws

public int read()

Returns

Throws

public boolean ready()

Returns

Throws

public void reset()

Throws

public long skip(long count)

Parameters

Returns

Throws

Known Direct Subclasses

Known Indirect Subclasses

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Methods inherited from interface java.lang.Readable

Known Direct Subclasses

Known Indirect Subclasses

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Methods inherited from interface java.lang.Readable

java.io
public abstract class

java.lang.Object
	java.io.Reader	Closeable Readable

Reader is an Abstract class for reading Character Streams. Subclasses of Reader must implement the methods read(char[], int, int) and close().

BufferedReader, CharArrayReader, FilterReader, InputStreamReader, PipedReader, StringReader

FileReader, LineNumberReader, PushbackReader

protected Object lock The object used to synchronize access to the reader.

abstract	void	close()
		Close this Reader.
	void	mark(int readLimit)
		Set a Mark position in this Reader.
	boolean	markSupported()
		Returns a boolean indicating whether or not this Reader supports mark() and reset().
abstract	int	read(char[] buf, int offset, int count)
		Reads at most `count` characters from this Reader and stores them at `offset` in the character array `buf`.
	int	read(CharBuffer target)
		Read chars from the Reader and then put them to the `target` CharBuffer.
	int	read(char[] buf)
		Reads characters from this Reader and stores them in the character array `buf` starting at offset 0.
	int	read()
		Reads a single character from this reader and returns the result as an int.
	boolean	ready()
		Returns a `boolean` indicating whether or not this Reader is ready to be read without blocking.
	void	reset()
		Reset this Readers position to the last `mark()` location.
	long	skip(long count)
		Skips `count` number of characters in this Reader.

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class<? extends Object>	getClass()
		Returns the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Returns an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Returns a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

read

The object used to synchronize access to the reader.

Constructs a new character stream Reader using this as the Object to synchronize critical regions around.

Constructs a new character stream Reader using lock as the Object to synchronize critical regions around.

lock	the `Object` to synchronize critical regions around.

Close this Reader. This must be implemented by any concrete subclasses. The implementation should free any resources associated with the Reader.

IOException	If an error occurs attempting to close this Reader.

Set a Mark position in this Reader. The parameter readLimit indicates how many characters can be read before a mark is invalidated. Sending reset() will reposition the reader back to the marked position provided readLimit has not been surpassed.

This default implementation simply throws IOException and concrete subclasses must provide their own implementations.

readLimit	an int representing how many characters must be read before invalidating the mark.

IOException	If an error occurs attempting mark this Reader.

Returns a boolean indicating whether or not this Reader supports mark() and reset(). This class a default implementation which returns false.

true if mark() and reset() are supported, false otherwise. This implementation returns false.

Reads at most count characters from this Reader and stores them at offset in the character array buf. Returns the number of characters actually read or -1 if the end of reader was encountered.

buf	character array to store the read characters
offset	offset in buf to store the read characters
count	how many characters should be read in

how many characters were successfully read in or else -1 if the end of the reader was detected.

IOException	If the Reader is already closed or some other IO error occurs.

Read chars from the Reader and then put them to the target CharBuffer. Only put method is called on the target.

target	the destination CharBuffer

the actual number of chars put to the target. -1 when the Reader has reached the end before the method is called.

IOException	if any I/O error raises in the procedure
NullPointerException	if the target CharBuffer is null
ReadOnlyBufferException	if the target CharBuffer is readonly

Reads characters from this Reader and stores them in the character array buf starting at offset 0. Returns the number of characters actually read or -1 if the end of reader was encountered.

buf	character array to store the read characters

how many characters were successfully read in or else -1 if the end of the reader was detected.

IOException	If the Reader is already closed or some other IO error occurs.

Reads a single character from this reader and returns the result as an int. The 2 higher-order characters are set to 0. If the end of reader was encountered then return -1.

the character read or -1 if end of reader.

IOException	If the Reader is already closed or some other IO error occurs.

Returns a boolean indicating whether or not this Reader is ready to be read without blocking. If the result is true, the next read() will not block. If the result is false this Reader may or may not block when read() is sent.

true if the receiver will not block when read() is called, false if unknown or blocking will occur.

IOException	If the Reader is already closed or some other IO error occurs.

Reset this Readers position to the last mark() location. Invocations of read()/skip() will occur from this new location. If this Reader was not marked, the implementation of reset() is implementation specific. See the comment for the specific Reader subclass for implementation details. The default action is to throw IOException.

IOException	If a problem occured or the receiver does not support `mark()/reset()`.

Skips count number of characters in this Reader. Subsequent read()'s will not return these characters unless reset() is used. This method may perform multiple reads to read count characters.

count	how many characters should be passed over

how many characters were successfully passed over

IOException	If the Reader is closed when the call is made or if an IO error occurs during the operation.

BufferedReader	BufferedReader is a buffered character input reader.
CharArrayReader	CharArrayReader is used as a buffered character input stream on a character array.
FilterReader	FilterReader is a class which takes a Reader and filters the input in some way.
InputStreamReader	InputStreamReader is class for turning a byte Stream into a character Stream.
PipedReader	PipedReader is a class which receives information on a communications pipe.
StringReader	StringReader is used as a character input stream on a String.

FileReader	FileReader is class for turning a file into a character Stream.
LineNumberReader	LineNumberReader is a buffered character input reader which counts line numbers as data is being read.
PushbackReader	PushbackReader is a filter class which allows chars read to be pushed back into the stream so that they can be reread.

					void	close()
						Close the object and release any system resources it holds.

					int	read(CharBuffer cb)
						Reads the characters into the given `CharBuffer`.


e.g. "intent" or "activity"

Constructs a new character stream Reader using this as the Object to synchronize critical regions around.

Reader(Object lock)

Constructs a new character stream Reader using lock as the Object to synchronize critical regions around.