javolution.io

Class CharSequenceReader

java.lang.Object

java.io.Reader

javolution.io.CharSequenceReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class CharSequenceReader
extends Reader

This class allows any CharSequence to be used as a reader.

Version:

3.8, May 8, 2004

Author:

Jean-Marie Dautelle

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
CharSequenceReader() Creates a new character sequence reader for which the character sequence input is not set.
CharSequenceReader(CharSequence input) Creates a new character sequence reader for which the character sequence input is set.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes and resets this reader for reuse.
CharSequence	getInput() Returns the character sequence to use for reading.
int	read() Reads a single character.
void	read(Appendable dest) Reads characters into the specified appendable.
int	read(char[] cbuf, int off, int len) Reads characters into a portion of an array.
boolean	ready() Indicates if this stream is ready to be read.
void	reset()
void	setInput(CharSequence input) Sets the character sequence to use for reading.

Methods inherited from class java.io.Reader

mark, markSupported, read, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

CharSequenceReader

public CharSequenceReader()

Creates a new character sequence reader for which the character sequence input is not set.

See Also:

setInput(java.lang.CharSequence)

CharSequenceReader

public CharSequenceReader(CharSequence input)

Creates a new character sequence reader for which the character sequence input is set.

Parameters:

input - the character sequence to be read.

Method Detail

setInput

public void setInput(CharSequence input)

Sets the character sequence to use for reading.

Parameters:

input - the character sequence to be read.

Throws:

IllegalStateException - if this reader is being reused and it has not been closed or reset.

getInput

public CharSequence getInput()

Returns the character sequence to use for reading.

ready

public boolean ready()
              throws IOException

Indicates if this stream is ready to be read.

Overrides:

ready in class Reader

Returns:

true if this reader has remaining characters to read; false otherwise.

Throws:

IOException - if an I/O error occurs.

close

public void close()

Closes and resets this reader for reuse.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

read

public int read()
         throws IOException

Reads a single character. This method does not block, -1 is returned if the end of the character sequence input has been reached.

Overrides:

read in class Reader

Returns:

the 31-bits Unicode of the character read, or -1 if there is no more remaining bytes to be read.

Throws:

IOException - if an I/O error occurs (e.g. incomplete character sequence being read).

read

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

Reads characters into a portion of an array. This method does not block.

Specified by:

read in class Reader

Parameters:

cbuf - the destination buffer.

off - the offset at which to start storing characters.

len - the maximum number of characters to read

Returns:

the number of characters read, or -1 if there is no more character to be read.

Throws:

IOException - if an I/O error occurs.

read

public void read(Appendable dest)
          throws IOException

Reads characters into the specified appendable. This method does not block.

Parameters:

dest - the destination buffer.

Throws:

IOException - if an I/O error occurs.

reset

public void reset()

Overrides:

reset in class Reader