org.apache.xerces.impl.io
Class UTF8Reader
Reader
org.apache.xerces.impl.io.UTF8Reader
public class UTF8Reader
extends Reader
A UTF-8 reader.
$Id: UTF8Reader.java 422572 2006-07-16 23:48:08Z mrglavas $
UTF8Reader(InputStream inputStream) - Constructs a UTF-8 reader from the specified input stream
using the default buffer size.
|
UTF8Reader(InputStream inputStream, byte[] buffer, MessageFormatter messageFormatter, Locale locale) - Constructs a UTF-8 reader from the specified input stream,
buffer and MessageFormatter.
|
UTF8Reader(InputStream inputStream, int size, MessageFormatter messageFormatter, Locale locale) - Constructs a UTF-8 reader from the specified input stream,
buffer size and MessageFormatter.
|
UTF8Reader(InputStream inputStream, MessageFormatter messageFormatter, Locale locale) - Constructs a UTF-8 reader from the specified input stream
using the default buffer size and the given MessageFormatter.
|
void | close() - Close the stream.
|
void | mark(int readAheadLimit) - Mark the present position in the stream.
|
boolean | markSupported() - Tell whether this stream supports the mark() operation.
|
int | read() - Read a single character.
|
int | read(ch[] , int offset, int length) - Read characters into a portion of an array.
|
boolean | ready() - Tell whether this stream is ready to be read.
|
void | reset() - Reset the stream.
|
long | skip(long n) - Skip characters.
|
DEFAULT_BUFFER_SIZE
public static final int DEFAULT_BUFFER_SIZE
Default byte buffer size (2048).
fBuffer
protected final byte[] fBuffer
Byte buffer.
fInputStream
protected final InputStream fInputStream
Input stream.
fOffset
protected int fOffset
Offset into buffer.
UTF8Reader
public UTF8Reader(InputStream inputStream)
Constructs a UTF-8 reader from the specified input stream
using the default buffer size. Primarily for testing.
inputStream
- The input stream.
UTF8Reader
public UTF8Reader(InputStream inputStream,
byte[] buffer,
MessageFormatter messageFormatter,
Locale locale)
Constructs a UTF-8 reader from the specified input stream,
buffer and MessageFormatter.
inputStream
- The input stream.buffer
- The byte buffer.messageFormatter
- the formatter for localizing/formatting errors.locale
- the Locale to use for messages
UTF8Reader
public UTF8Reader(InputStream inputStream,
int size,
MessageFormatter messageFormatter,
Locale locale)
Constructs a UTF-8 reader from the specified input stream,
buffer size and MessageFormatter.
inputStream
- The input stream.size
- The initial buffer size.messageFormatter
- the formatter for localizing/formatting errors.locale
- the Locale to use for messages
UTF8Reader
public UTF8Reader(InputStream inputStream,
MessageFormatter messageFormatter,
Locale locale)
Constructs a UTF-8 reader from the specified input stream
using the default buffer size and the given MessageFormatter.
inputStream
- The input stream.messageFormatter
- given MessageFormatterlocale
- Locale to use for messages
close
public void close()
throws IOException
Close the stream. Once a stream has been closed, further read(),
ready(), mark(), or reset() invocations will throw an IOException.
Closing a previously-closed stream, however, has no effect.
mark
public void mark(int readAheadLimit)
throws IOException
Mark the present position in the stream. Subsequent calls to reset()
will attempt to reposition the stream to this point. Not all
character-input streams support the mark() operation.
readAheadLimit
- Limit on the number of characters that may be
read while still preserving the mark. After
reading this many characters, attempting to
reset the stream may fail.
markSupported
public boolean markSupported()
Tell whether this stream supports the mark() operation.
read
public int read()
throws IOException
Read a single character. This method will block until a character is
available, an I/O error occurs, or the end of the stream is reached.
Subclasses that intend to support efficient single-character input
should override this method.
- The character read, as an integer in the range 0 to 16383
(0x00-0xffff), or -1 if the end of the stream has
been reached
read
public int read(ch[] ,
int offset,
int length)
throws IOException
Read characters into a portion of an array. This method will block
until some input is available, an I/O error occurs, or the end of the
stream is reached.
offset
- Offset at which to start storing characterslength
- Maximum number of characters to read
- The number of characters read, or -1 if the end of the
stream has been reached
ready
public boolean ready()
throws IOException
Tell whether this stream is ready to be read.
- 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.
reset
public void reset()
throws IOException
Reset the stream. If the stream has been marked, then attempt to
reposition it at the mark. If the stream has not been marked, then
attempt to reset it in some way appropriate to the particular stream,
for example by repositioning it to its starting point. Not all
character-input streams support the reset() operation, and some support
reset() without supporting mark().
skip
public long skip(long n)
throws IOException
Skip characters. This method will block until some characters are
available, an I/O error occurs, or the end of the stream is reached.
n
- The number of characters to skip
- The number of characters actually skipped
Copyright B) 1999-2006 The Apache Software Foundation. All Rights Reserved.