OpenJDK 1.22 · java.io.CharArrayReader · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected char[]	buf The character buffer.
protected int	count The index of the end of this buffer.
protected int	markedPos The position of mark in buffer.
protected int	pos The current buffer position.

Access	Constructor and Description
public	CharArrayReader(char[] Input buffer (not copied) buf) Creates a CharArrayReader from the specified array of chars.
public	CharArrayReader(char[] Input buffer (not copied) buf, int Offset of the first char to read offset, int Number of chars to read length) Creates a CharArrayReader from the specified array of chars.

Method Summary

Modifier and Type	Method and Description
public 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 void	ensureOpen() Checks to make sure that the stream has not been closed
public void	mark(int Limit on the number of characters that may be read while still preserving the mark. Because the stream's input comes from a character array, there is no actual limit; hence this argument is ignored. 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, which it does.
public int	read() Overrides java.io.Reader.read. Reads a single character.
public int	Returns: The number of characters read, or -1 if the end of the stream has been reached 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 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 boolean	ready() Overrides java.io.Reader.ready. Tells whether this stream is ready to be read.
public void	reset() Overrides java.io.Reader.reset. Resets the stream to the most recent mark, or to the beginning if it has never been marked.
public long	Returns: The number of characters actually skipped skip(long The number of characters to skip n) Overrides java.io.Reader.skip. Skips characters.

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

Field Detail

buf	back to summary
protected char[] buf The character buffer.

count	back to summary
protected int count The index of the end of this buffer. There is no valid data at or beyond this index.

markedPos	back to summary
protected int markedPos The position of mark in buffer.

pos	back to summary
protected int pos The current buffer position.

Constructor Detail

CharArrayReader	back to summary
public CharArrayReader(char[] buf) Creates a CharArrayReader from the specified array of chars. Parameters buf:char[] Input buffer (not copied)

CharArrayReader

back to summary

public CharArrayReader(char[] buf)

Creates a CharArrayReader from the specified array of chars.

Parameters

buf:char[]: Input buffer (not copied)

CharArrayReader back to summary

CharArrayReader	back to summary
public CharArrayReader(char[] buf, int offset, int length) Creates a CharArrayReader from the specified array of chars. The resulting reader will start reading at the given `offset`. The total number of `char` values that can be read from this reader will be either `length` or `buf.length-offset`, whichever is smaller. Parameters buf:char[] Input buffer (not copied) offset:int Offset of the first char to read length:int Number of chars to read Exceptions IllegalArgumentException: If `offset` is negative or greater than `buf.length`, or if `length` is negative, or if the sum of these two values is negative.

public CharArrayReader(char[] buf, int offset, int length)

Creates a CharArrayReader from the specified array of chars.

The resulting reader will start reading at the given offset. The total number of char values that can be read from this reader will be either length or buf.length-offset, whichever is smaller.

Parameters

buf:char[]: Input buffer (not copied)
offset:int: Offset of the first char to read
length:int: Number of chars to read

Exceptions

IllegalArgumentException:: If offset is negative or greater than buf.length, or if length is negative, or if the sum of these two values is negative.

Method Detail

close	back to summary
public void close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.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. This method will block while there is another thread blocking on the reader.

back to summary

public void close()

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.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. This method will block while there is another thread blocking on the reader.

ensureOpen	back to summary
private void ensureOpen() throws IOException Checks to make sure that the stream has not been closed

mark	back to summary
public void mark(int readAheadLimit) throws IOException Overrides java.io.Reader.mark. Marks the present position in the stream. Subsequent calls to reset() will reposition the stream to this point. Parameters readAheadLimit:int Limit on the number of characters that may be read while still preserving the mark. Because the stream's input comes from a character array, there is no actual limit; hence this argument is ignored. Exceptions IOException: If an I/O error occurs

mark

back to summary

public void mark(int readAheadLimit) throws IOException

Overrides java.io.Reader.mark.

Marks the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.

Parameters

readAheadLimit:int: Limit on the number of characters that may be read while still preserving the mark. Because the stream's input comes from a character array, there is no actual limit; hence this argument is ignored.

Exceptions

IOException:: If an I/O error occurs

markSupported	back to summary
public boolean markSupported() Overrides java.io.Reader.markSupported. Tells whether this stream supports the mark() operation, which it does. Returns:boolean Doc from java.io.Reader.markSupported. true if and only if this stream supports the mark operation.

markSupported

back to summary

public boolean markSupported()

Overrides java.io.Reader.markSupported.

Tells whether this stream supports the mark() operation, which it does.

Returns:boolean

Doc from java.io.Reader.markSupported.

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

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.Reader.read. Reads a single character. Returns:int Doc from java.io.Reader.read. 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 Exceptions IOException: If an I/O error occurs

public int read() throws IOException

Overrides java.io.Reader.read.

Reads a single character.

Returns:int

Doc from java.io.Reader.read.

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

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(char[] cbuf, int off, int len) throws IOException Implements abstract java.io.Reader.read. Reads characters into a portion of an array. 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[] Doc from java.io.Reader.read. Destination buffer off:int Doc from java.io.Reader.read. Offset at which to start storing characters len:int Doc from java.io.Reader.read. Maximum number of characters to read Returns:int Doc from java.io.Reader.read. The number of characters read, or -1 if the end of the stream has been reached Exceptions IOException: If an I/O error occurs IndexOutOfBoundsException: If `off` is negative, or `len` is negative, or `len` is greater than `cbuf.length - off`

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

Implements abstract java.io.Reader.read.

Reads characters into a portion of an array.

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[]

Doc from java.io.Reader.read.

Destination buffer

off:int

Doc from java.io.Reader.read.

Offset at which to start storing characters

len:int

Doc from java.io.Reader.read.

Maximum number of characters to read

Returns:int

Doc from java.io.Reader.read.

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

Exceptions

IOException:: If an I/O error occurs
IndexOutOfBoundsException:: If off is negative, or len is negative, or len is greater than cbuf.length - off

read	back to summary
public 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. If the length of the specified character buffer is zero, then no characters will be read and zero will be returned. Parameters target:CharBuffer the buffer to read characters into Returns:int The number of characters added to the buffer, possibly zero, 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 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. If the length of the specified character buffer is zero, then no characters will be read and zero will be returned.

Parameters

target:CharBuffer: the buffer to read characters into

Returns:int

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

ready	back to summary
public boolean ready() throws IOException Overrides java.io.Reader.ready. Tells whether this stream is ready to be read. Character-array readers are always ready to be read. Returns:boolean Doc from java.io.Reader.ready. 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. Exceptions IOException: If an I/O error occurs

ready

back to summary

public boolean ready() throws IOException

Overrides java.io.Reader.ready.

Tells whether this stream is ready to be read. Character-array readers are always ready to be read.

Returns:boolean

Doc from java.io.Reader.ready.

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.

Exceptions

IOException:: If an I/O error occurs

reset	back to summary
public void reset() throws IOException Overrides java.io.Reader.reset. Resets the stream to the most recent mark, or to the beginning if it has never been marked. Exceptions IOException: If an I/O error occurs

reset

back to summary

public void reset() throws IOException

Overrides java.io.Reader.reset.

Resets the stream to the most recent mark, or to the beginning if it has never been marked.

Exceptions

IOException:: If an I/O error occurs

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.Reader.skip. Skips characters. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned. The `n` parameter may be negative, even though the `skip` method of the `Reader` superclass throws an exception in this case. If `n` is negative, then this method does nothing and returns `0`. Parameters n:long Doc from java.io.Reader.skip. The number of characters to skip Returns:long Doc from java.io.Reader.skip. The number of characters actually skipped Exceptions IOException: If an I/O error occurs

public long skip(long n) throws IOException

Overrides java.io.Reader.skip.

Skips characters. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned.

The n parameter may be negative, even though the skip method of the Reader superclass throws an exception in this case. If n is negative, then this method does nothing and returns 0.

Parameters

n:long

Doc from java.io.Reader.skip.

The number of characters to skip

Returns:long

Doc from java.io.Reader.skip.

The number of characters actually skipped

Exceptions

IOException:: If an I/O error occurs

public Class CharArrayReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail