net.pwall.util

Class ReaderBuffer

java.lang.Object

net.pwall.util.ReaderBuffer

All Implemented Interfaces:

CharSequence

public class ReaderBuffer
extends Object
implements CharSequence

An implementation of CharSequence that provides read-only random access to the data input from a Reader.

Author:

Peter Wall

Field Summary

Fields

Modifier and Type	Field and Description
static int	defaultBufferSize Default buffer size = 4096

Constructor Summary

Constructors

Constructor and Description
ReaderBuffer(Reader rdr) Create a ReaderBuffer with the contents taken from the nominated Reader, using the default buffer size.
ReaderBuffer(Reader rdr, int bufferSize) Create a ReaderBuffer with the contents taken from the nominated Reader, using the specified buffer size.

Method Summary

Modifier and Type	Method and Description
char	charAt(int index) Get the character at the specified index.
int	length() Get the total length of the CharSequence.
CharSequence	subSequence(int start, int end) Get a sub-sequence of this CharSequence.
String	toString() Get the string from this CharSequence.
static String	toString(Reader rdr) Convenience method to convert the contents of a Reader to a String.
static String	toString(Reader rdr, int bufferSize) Convenience method to convert the contents of a Reader to a String using a specified buffer size.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Detail

defaultBufferSize

public static final int defaultBufferSize

Default buffer size = 4096

See Also:

Constant Field Values

Constructor Detail

ReaderBuffer

public ReaderBuffer(Reader rdr,
                    int bufferSize)
             throws IOException

Create a ReaderBuffer with the contents taken from the nominated Reader, using the specified buffer size. Read the data into a set of character arrays in an ArrayList, so that it can be accessed by the CharSequence interface.

Parameters:

rdr - the Reader

bufferSize - the buffer size to use

Throws:

IOException - if thrown by the Reader

ReaderBuffer

public ReaderBuffer(Reader rdr)
             throws IOException

Create a ReaderBuffer with the contents taken from the nominated Reader, using the default buffer size.

Parameters:

rdr - the Reader

Throws:

IOException - if thrown by the Reader

Method Detail

length

public int length()

Get the total length of the CharSequence.

Specified by:

length in interface CharSequence

Returns:

the length

See Also:

CharSequence.length()

charAt

public char charAt(int index)

Get the character at the specified index.

Specified by:

charAt in interface CharSequence

Parameters:

index - the index

Returns:

the character

Throws:

IndexOutOfBoundsException - if index less than 0 or greater than length

See Also:

CharSequence.charAt(int)

subSequence

public CharSequence subSequence(int start,
                                int end)

Get a sub-sequence of this CharSequence.

Specified by:

subSequence in interface CharSequence

Parameters:

start - the start index

end - the end index

Returns:

the sub-sequence

Throws:

IllegalArgumentException - if the start or end index is invalid

See Also:

CharSequence.subSequence(int, int)

toString

public String toString()

Get the string from this CharSequence. The result is stored for subsequent re-use.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

Returns:

the string containing all the characters of this CharSequence

See Also:

Object.toString()

toString

public static String toString(Reader rdr)
                       throws IOException

Convenience method to convert the contents of a Reader to a String.

Parameters:

rdr - the Reader

Returns:

the String

Throws:

IOException - if thrown by the Reader

toString

public static String toString(Reader rdr,
                              int bufferSize)
                       throws IOException

Convenience method to convert the contents of a Reader to a String using a specified buffer size.

Parameters:

rdr - the Reader

bufferSize - the buffer size

Returns:

the String

Throws:

IOException - if thrown by the Reader