Xerces2-j 2.12.2 · org.apache.xerces.impl.io.UCSReader

Modifier and Type	Field and Description
public static final int	DEFAULT_BUFFER_SIZE Default byte buffer size (8192, larger than that of ASCIIReader since it's reasonable to surmise that the average UCS-4-encoded file should be 4 times as large as the average ASCII-encoded file).
protected final byte[]	fBuffer Byte buffer.
protected final short	fEncoding
protected final InputStream	fInputStream Input stream.
public static final short	UCS2BE
public static final short	UCS2LE
public static final short	UCS4BE
public static final short	UCS4LE

Access	Constructor and Description
public	UCSReader(InputStream The input stream. inputStream, short One of UCS2LE, UCS2BE, UCS4LE or UCS4BE. encoding) Constructs a UCS reader from the specified input stream using the default buffer size.
public	UCSReader(InputStream The input stream. inputStream, int The initial buffer size. size, short One of UCS2LE, UCS2BE, UCS4LE or UCS4BE. encoding) Constructs a UCS reader from the specified input stream and buffer size.
public	UCSReader(InputStream The input stream. inputStream, byte[] The byte buffer. buffer, short One of UCS2LE, UCS2BE, UCS4LE or UCS4BE. encoding) Constructs a UCS reader from the specified input stream and buffer.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Close the stream.
public void	mark(int 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. readAheadLimit) Overrides java.io.Reader.mark. Mark the present position in the stream.
public boolean	markSupported() Overrides java.io.Reader.markSupported. Tell whether this stream supports the mark() operation.
public int	Returns: The character read, as an integer in the range 0 to 127 (`0x00-0x7f`), or -1 if the end of the stream has been reached read() Overrides java.io.Reader.read. Read a single character.
public int	Returns: The number of characters read, or -1 if the end of the stream has been reached read(char[] Destination buffer ch, int Offset at which to start storing characters offset, int Maximum number of characters to read length) Implements abstract java.io.Reader.read. Read characters into a portion of an array.
public boolean	Returns: 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. ready() Overrides java.io.Reader.ready. Tell whether this stream is ready to be read.
public void	reset() Overrides java.io.Reader.reset. Reset the stream.
public long	Returns: The number of characters actually skipped skip(long The number of characters to skip n) Overrides java.io.Reader.skip. Skip characters.

Inherited from java.io.Reader:: nullReader read read transferTo

Field Detail

DEFAULT_BUFFER_SIZE	back to summary
public static final int DEFAULT_BUFFER_SIZE Default byte buffer size (8192, larger than that of ASCIIReader since it's reasonable to surmise that the average UCS-4-encoded file should be 4 times as large as the average ASCII-encoded file).

fBuffer	back to summary
protected final byte[] fBuffer Byte buffer.

fEncoding	back to summary
protected final short fEncoding

fInputStream	back to summary
protected final InputStream fInputStream Input stream.

UCS2BE	back to summary
public static final short UCS2BE

UCS2LE	back to summary
public static final short UCS2LE

UCS4BE	back to summary
public static final short UCS4BE

UCS4LE	back to summary
public static final short UCS4LE

Constructor Detail

UCSReader	back to summary
public UCSReader(InputStream inputStream, short encoding) Constructs a UCS reader from the specified input stream using the default buffer size. The Endian-ness and whether this is UCS-2 or UCS-4 needs also to be known in advance. Parameters inputStream:InputStream The input stream. encoding:short One of UCS2LE, UCS2BE, UCS4LE or UCS4BE.

UCSReader

back to summary

public UCSReader(InputStream inputStream, short encoding)

Constructs a UCS reader from the specified input stream using the default buffer size. The Endian-ness and whether this is UCS-2 or UCS-4 needs also to be known in advance.

Parameters

inputStream:InputStream: The input stream.
encoding:short: One of UCS2LE, UCS2BE, UCS4LE or UCS4BE.

UCSReader	back to summary
public UCSReader(InputStream inputStream, int size, short encoding) Constructs a UCS reader from the specified input stream and buffer size. The Endian-ness and whether this is UCS-2 or UCS-4 needs also to be known in advance. Parameters inputStream:InputStream The input stream. size:int The initial buffer size. encoding:short One of UCS2LE, UCS2BE, UCS4LE or UCS4BE.

UCSReader

back to summary

public UCSReader(InputStream inputStream, int size, short encoding)

Constructs a UCS reader from the specified input stream and buffer size. The Endian-ness and whether this is UCS-2 or UCS-4 needs also to be known in advance.

Parameters

inputStream:InputStream: The input stream.
size:int: The initial buffer size.
encoding:short: One of UCS2LE, UCS2BE, UCS4LE or UCS4BE.

UCSReader	back to summary
public UCSReader(InputStream inputStream, byte[] buffer, short encoding) Constructs a UCS reader from the specified input stream and buffer. The Endian-ness and whether this is UCS-2 or UCS-4 needs also to be known in advance. Parameters inputStream:InputStream The input stream. buffer:byte[] The byte buffer. encoding:short One of UCS2LE, UCS2BE, UCS4LE or UCS4BE.

UCSReader

back to summary

public UCSReader(InputStream inputStream, byte[] buffer, short encoding)

Constructs a UCS reader from the specified input stream and buffer. The Endian-ness and whether this is UCS-2 or UCS-4 needs also to be known in advance.

Parameters

inputStream:InputStream: The input stream.
buffer:byte[]: The byte buffer.
encoding:short: One of UCS2LE, UCS2BE, UCS4LE or UCS4BE.

Method Detail

close	back to summary
public void close() throws IOException Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. 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. Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

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.

Exceptions

IOException:: If an I/O error occurs

mark	back to summary
public void mark(int readAheadLimit) throws IOException Overrides java.io.Reader.mark. 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. Parameters readAheadLimit:int 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. Exceptions IOException: If the stream does not support mark(), or if some other I/O error occurs

mark

back to summary

public void mark(int readAheadLimit) throws IOException

Overrides java.io.Reader.mark.

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.

Parameters

readAheadLimit:int: 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.

Exceptions

IOException:: If the stream does not support mark(), or if some other I/O error occurs

markSupported	back to summary
public boolean markSupported() Overrides java.io.Reader.markSupported. Tell whether this stream supports the mark() operation. Returns:boolean Doc from java.io.Reader.markSupported. true if and only if this stream supports the mark operation.

markSupported

back to summary

public boolean markSupported()

Overrides java.io.Reader.markSupported.

Tell whether this stream supports the mark() operation.

Returns:boolean

Doc from java.io.Reader.markSupported.

true if and only if this stream supports the mark operation.

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.Reader.read. 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. Returns:int The character read, as an integer in the range 0 to 127 (`0x00-0x7f`), or -1 if the end of the stream has been reached Exceptions IOException: If an I/O error occurs

public int read() throws IOException

Overrides java.io.Reader.read.

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.

Returns:int

The character read, as an integer in the range 0 to 127 (0x00-0x7f), or -1 if the end of the stream has been reached

Exceptions

IOException:: If an I/O error occurs

read	back to summary
public int read(char[] ch, int offset, int length) throws IOException Implements abstract java.io.Reader.read. 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. Parameters ch:char[] Destination buffer offset:int Offset at which to start storing characters length:int Maximum number of characters to read Returns:int The number of characters read, or -1 if the end of the stream has been reached Exceptions IOException: If an I/O error occurs

read

back to summary

public int read(char[] ch, int offset, int length) throws IOException

Implements abstract java.io.Reader.read.

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.

Parameters

ch:char[]: Destination buffer
offset:int: Offset at which to start storing characters
length:int: Maximum number of characters to read

Returns:int

The number of characters read, or -1 if the end of the stream has been reached

Exceptions

IOException:: If an I/O error occurs

ready	back to summary
public boolean ready() throws IOException Overrides java.io.Reader.ready. Tell whether this stream is ready to be read. Returns:boolean 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. Exceptions IOException: If an I/O error occurs

ready

back to summary

public boolean ready() throws IOException

Overrides java.io.Reader.ready.

Tell whether this stream is ready to be read.

Returns:boolean

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.

Exceptions

IOException:: If an I/O error occurs

reset	back to summary
public void reset() throws IOException Overrides java.io.Reader.reset. 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(). Exceptions IOException: If the stream has not been marked, or if the mark has been invalidated, or if the stream does not support reset(), or if some other I/O error occurs

reset

back to summary

public void reset() throws IOException

Overrides java.io.Reader.reset.

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().

Exceptions

IOException:: If the stream has not been marked, or if the mark has been invalidated, or if the stream does not support reset(), or if some other I/O error occurs

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.Reader.skip. Skip characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached. Parameters n:long The number of characters to skip Returns:long The number of characters actually skipped Exceptions IOException: If an I/O error occurs

skip

back to summary

public long skip(long n) throws IOException

Overrides java.io.Reader.skip.

Skip characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached.

Parameters

n:long: The number of characters to skip

Returns:long

The number of characters actually skipped

Exceptions

IOException:: If an I/O error occurs

public final Class UCSReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail