org.apache.commons.io.input

Class CharSequenceReader

Implemented Interfaces:
Serializable

public class CharSequenceReader
extends Reader
implements Serializable

Reader implementation that can read from String, StringBuffer, StringBuilder or CharBuffer.

Note: Supports mark(int) and reset().

Version:
$Revision: 610516 $ $Date: 2008-01-09 19:05:05 +0000 (Wed, 09 Jan 2008) $
Since:
Commons IO 1.4

Field Summary

private CharSequence
charSequence
private int
idx
private int
mark

Constructor Summary

CharSequenceReader(CharSequence charSequence)
Construct a new instance with the specified character sequence.

Method Summary

void
close()
Close resets the file back to the start and removes any marked position.
void
mark(int readAheadLimit)
Mark the current position.
boolean
markSupported()
Mark is supported (returns true).
int
read()
Read a single character.
int
read(char[] array, int offset, int length)
Read the sepcified number of characters into the array.
void
reset()
Reset the reader to the last marked position (or the beginning if mark has not been called).
long
skip(long n)
Skip the specified number of characters.
String
toString()
Return a String representation of the underlying character sequence.

Field Details

charSequence

private final CharSequence charSequence

idx

private int idx

mark

private int mark

Constructor Details

CharSequenceReader

public CharSequenceReader(CharSequence charSequence)
Construct a new instance with the specified character sequence.
Parameters:
charSequence - The character sequence, may be null

Method Details

close

public void close()
Close resets the file back to the start and removes any marked position.

mark

public void mark(int readAheadLimit)
Mark the current position.
Parameters:
readAheadLimit - ignored

markSupported

public boolean markSupported()
Mark is supported (returns true).
Returns:
true

read

public int read()
Read a single character.
Returns:
the next character from the character sequence or -1 if the end has been reached.

read

public int read(char[] array,
                int offset,
                int length)
Read the sepcified number of characters into the array.
Parameters:
array - The array to store the characters in
offset - The starting position in the array to store
length - The maximum number of characters to read
Returns:
The number of characters read or -1 if there are no more

reset

public void reset()
Reset the reader to the last marked position (or the beginning if mark has not been called).

skip

public long skip(long n)
Skip the specified number of characters.
Parameters:
n - The number of characters to skip
Returns:
The actual number of characters skipped

toString

public String toString()
Return a String representation of the underlying character sequence.
Returns:
The contents of the character sequence

Copyright (c) 2002-2009 Apache Software Foundation