Guava: Google Core Libraries for Java 32.1.2-jre · com.google.common.io.CharSequenceReader

Modifier and Type	Field and Description
private int	mark
private int	pos
private CharSequence	seq

Access	Constructor and Description
public	CharSequenceReader(CharSequence seq) Creates a new reader wrapping the given character sequence.

Method Summary

Modifier and Type	Method and Description
private void	checkOpen()
public synchronized void	close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Closes the stream and releases any system resources associated with it.
private boolean	hasRemaining()
public synchronized void	mark(int Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail. readAheadLimit) Overrides java.io.Reader.mark. Marks the present position in the stream.
public boolean	markSupported() Overrides java.io.Reader.markSupported. Tells whether this stream supports the mark() operation.
public synchronized int	read(CharBuffer the buffer to read characters into target) Overrides java.io.Reader.read. Implements java.lang.Readable.read. Attempts to read characters into the specified character buffer.
public synchronized int	read() Overrides java.io.Reader.read. Reads a single character.
public synchronized int	read(char[] Destination buffer cbuf, int Offset at which to start storing characters off, int Maximum number of characters to read len) Implements abstract java.io.Reader.read. Reads characters into a portion of an array.
public synchronized boolean	ready() Overrides java.io.Reader.ready. Tells whether this stream is ready to be read.
private int	remaining()
public synchronized void	reset() Overrides java.io.Reader.reset. Resets the stream.
public synchronized long	skip(long The number of characters to skip n) Overrides java.io.Reader.skip. Skips characters.

Inherited from java.io.Reader:: nullReader read transferTo

mark	back to summary
private int mark

pos	back to summary
private int pos

seq	back to summary
private CharSequence seq Annotations @CheckForNull

CharSequenceReader	back to summary
public CharSequenceReader(CharSequence seq) Creates a new reader wrapping the given character sequence.

Method Detail

checkOpen	back to summary
private void checkOpen() throws IOException

close	back to summary
public synchronized void close() throws IOException Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Doc from java.io.Reader.close. 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. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public synchronized void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Doc from java.io.Reader.close.

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.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

hasRemaining	back to summary
private boolean hasRemaining()

mark	back to summary
public synchronized void mark(int readAheadLimit) throws IOException Overrides java.io.Reader.mark. Doc from java.io.Reader.mark. 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:int Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail. Annotations @Override Exceptions IOException: If the stream does not support mark(), or if some other I/O error occurs

mark

back to summary

public synchronized void mark(int readAheadLimit) throws IOException

Overrides java.io.Reader.mark.

Doc from java.io.Reader.mark.

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:int: Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail.

Annotations

@Override

Exceptions

IOException:: If the stream does not support mark(), or if some other I/O error occurs

markSupported	back to summary
public boolean markSupported() Overrides java.io.Reader.markSupported. Doc from java.io.Reader.markSupported. Tells whether this stream supports the mark() operation. The default implementation always returns false. Subclasses should override this method. Returns:boolean true if and only if this stream supports the mark operation. Annotations @Override

markSupported

back to summary

public boolean markSupported()

Overrides java.io.Reader.markSupported.

Doc from java.io.Reader.markSupported.

Tells whether this stream supports the mark() operation. The default implementation always returns false. Subclasses should override this method.

Returns:boolean

true if and only if this stream supports the mark operation.

Annotations

@Override

read	back to summary
public synchronized int read(CharBuffer target) throws IOException Overrides java.io.Reader.read. Implements java.lang.Readable.read. Doc from java.io.Reader.read. 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:CharBuffer the buffer to read characters into Returns:int The number of characters added to the buffer, or -1 if this source of characters is at its end Annotations @Override Exceptions IOException: if an I/O error occurs

read

back to summary

public synchronized int read(CharBuffer target) throws IOException

Overrides java.io.Reader.read.

Implements java.lang.Readable.read.

Doc from java.io.Reader.read.

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:CharBuffer: the buffer to read characters into

Returns:int

The number of characters added to the buffer, or -1 if this source of characters is at its end

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

read back to summary

read	back to summary
public synchronized int read() throws IOException Overrides java.io.Reader.read. Doc from java.io.Reader.read. 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. Returns:int The character read, as an integer in the range 0 to 65535 (`0x00-0xffff`), or -1 if the end of the stream has been reached Annotations @Override Exceptions IOException: If an I/O error occurs

public synchronized int read() throws IOException

Overrides java.io.Reader.read.

Doc from java.io.Reader.read.

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.

Returns:int

The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public synchronized int read(char[] cbuf, int off, int len) throws IOException Implements abstract java.io.Reader.read. Doc from java.io.Reader.read. 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. If `len` is zero, then no characters are read and `0` is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value `-1` is returned; otherwise, at least one character is read and stored into `cbuf`. Parameters cbuf:char[] Destination buffer off:int Offset at which to start storing characters len:int Maximum number of characters to read Returns:int The number of characters read, or -1 if the end of the stream has been reached Annotations @Override Exceptions IOException: If an I/O error occurs

public synchronized int read(char[] cbuf, int off, int len) throws IOException

Implements abstract java.io.Reader.read.

Doc from java.io.Reader.read.

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.

If len is zero, then no characters are read and 0 is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1 is returned; otherwise, at least one character is read and stored into cbuf.

Parameters

cbuf:char[]: Destination buffer
off:int: Offset at which to start storing characters
len:int: Maximum number of characters to read

Returns:int

The number of characters read, or -1 if the end of the stream has been reached

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

ready	back to summary
public synchronized boolean ready() throws IOException Overrides java.io.Reader.ready. Doc from java.io.Reader.ready. Tells whether this stream is ready to be read. Returns:boolean True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block. Annotations @Override Exceptions IOException: If an I/O error occurs

ready

back to summary

public synchronized boolean ready() throws IOException

Overrides java.io.Reader.ready.

Doc from java.io.Reader.ready.

Tells whether this stream is ready to be read.

Returns:boolean

True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

remaining	back to summary
private int remaining()

reset	back to summary
public synchronized void reset() throws IOException Overrides java.io.Reader.reset. Doc from java.io.Reader.reset. 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(). Annotations @Override Exceptions 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

reset

back to summary

public synchronized void reset() throws IOException

Overrides java.io.Reader.reset.

Doc from java.io.Reader.reset.

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().

Annotations

@Override

Exceptions

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	back to summary
public synchronized long skip(long n) throws IOException Overrides java.io.Reader.skip. Doc from java.io.Reader.skip. Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned. Parameters n:long The number of characters to skip Returns:long The number of characters actually skipped Annotations @Override Exceptions IOException: If an I/O error occurs

skip

back to summary

public synchronized long skip(long n) throws IOException

Overrides java.io.Reader.skip.

Doc from java.io.Reader.skip.

Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned.

Parameters

n:long: The number of characters to skip

Returns:long

The number of characters actually skipped

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

pack-priv final Class CharSequenceReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail