A source of characters based on a String.
available
public int available()
Get the number of available characters.
- available in interface Source
- The number of characters that can be read or zero if the source
is closed.
close
public void close()
throws IOException
Does nothing.
It's supposed to close the source, but use destroy() instead.
- close in interface Source
destroy
public void destroy()
throws IOException
- destroy in interface Source
getCharacter
public char getCharacter(int offset)
throws IOException
Retrieve a character again.
- getCharacter in interface Source
offset
- The offset of the character.
getCharacters
public void getCharacters(StringBuffer buffer,
int offset,
int length)
throws IOException
Append characters already read into a
StringBuffer
.
Asking for characters ahead of
offset()
will throw an exception.
- getCharacters in interface Source
buffer
- The buffer to append to.offset
- The offset of the first character.length
- The number of characters to retrieve.
getCharacters
public void getCharacters(char[] array,
int offset,
int start,
int end)
throws IOException
Retrieve characters again.
- getCharacters in interface Source
array
- The array of characters.offset
- The starting position in the array where characters are to be placed.start
- The starting position, zero based.end
- The ending position
(exclusive, i.e. the character at the ending position is not included),
zero based.
getEncoding
public String getEncoding()
Get the encoding being used to convert characters.
- getEncoding in interface Source
getString
public String getString(int offset,
int length)
throws IOException
Retrieve a string comprised of characters already read.
Asking for characters ahead of
offset()
will throw an exception.
- getString in interface Source
offset
- The offset of the first character.length
- The number of characters to retrieve.
- A string containing the
length
characters at offset
.
mark
public void mark(int readAheadLimit)
throws IOException
Mark the present position in the source.
Subsequent calls to
reset()
will attempt to reposition the source to this point.
- mark in interface Source
readAheadLimit
- Not used.
markSupported
public boolean markSupported()
Tell whether this source supports the mark() operation.
- markSupported in interface Source
offset
public int offset()
Get the position (in characters).
- offset in interface Source
- The number of characters that have already been read, or
EOF
if the source is closed.
read
public int read()
throws IOException
Read a single character.
- read in interface Source
- The character read, as an integer in the range 0 to 65535
(0x00-0xffff), or
EOF
if the source is exhausted.
read
public int read(char[] cbuf)
throws IOException
Read characters into an array.
- read in interface Source
cbuf
- Destination buffer.
- The number of characters read, or
EOF
if the source
is exhausted.
read
public int read(char[] cbuf,
int off,
int len)
throws IOException
Read characters into a portion of an array.
- read in interface Source
cbuf
- Destination bufferoff
- Offset at which to start storing characterslen
- Maximum number of characters to read
- The number of characters read, or
EOF
if the source
is exhausted.
ready
public boolean ready()
throws IOException
Tell whether this source is ready to be read.
- ready in interface Source
- Equivalent to a non-zero
available()
, i.e. there are
still more characters to read.
reset
public void reset()
throws IllegalStateException
Reset the source.
Repositions the read point to begin at zero.
- reset in interface Source
setEncoding
public void setEncoding(String character_set)
throws ParserException
Set the encoding to the given character set.
This simply sets the encoding reported by
getEncoding()
.
- setEncoding in interface Source
character_set
- The character set to use to convert characters.
skip
public long skip(long n)
throws IOException,
IllegalArgumentException
Skip characters.
Note: n is treated as an int
- skip in interface Source
n
- The number of characters to skip.
- The number of characters actually skipped
unread
public void unread()
throws IOException
Undo the read of a single character.
- unread in interface Source