Top Description Fields Constructors Methods
com.ctc.wstx.io

public final Class MergedReader

extends Reader
Class Inheritance
Imports
java.io.*, com.ctc.wstx.api.ReaderConfig
Simple Reader implementation that is used to "unwind" some data previously read from a Reader; so that as long as some of that data remains, it's returned; but as long as it's read, we'll just use data from the underlying original Reader. This is similar to java.io.PushbackReader, but with this class there's only one implicit pushback, when instance is constructed; not general pushback buffer and methods to use it.

Field Summary

Modifier and TypeField and Description
pack-priv final ReaderConfig
mConfig

pack-priv char[]
mData

This buffer contains the partially read remains left over after bootstrapper has consumed xml declaration (if one found).

pack-priv final int
mEnd

pack-priv final Reader
mIn

pack-priv int
mPtr

Inherited from java.io.Reader:
lock

Constructor Summary

AccessConstructor and Description
public
MergedReader(ReaderConfig cfg, Reader in, char[] buf, int start, int end)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Closes the stream and releases any system resources associated with it.

private void
freeMergedBuffer()

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

Overrides java.io.Reader.mark.

Marks the present position in the stream.

public boolean
markSupported()

Overrides java.io.Reader.markSupported.

Tells whether this stream supports the mark() operation.

public int
read()

Overrides java.io.Reader.read.

Reads a single character.

public int
read(char[]
Destination buffer
cbuf)

Overrides java.io.Reader.read.

Reads characters into an array.

public int
read(char[]
Destination buffer
cbuf, int
Offset at which to start storing characters
off, int
Maximum number of characters to read
len)

Implements abstract java.io.Reader.read.

Reads characters into a portion of an array.

public boolean
ready()

Overrides java.io.Reader.ready.

Tells whether this stream is ready to be read.

public void
reset()

Overrides java.io.Reader.reset.

Resets the stream.

public long
skip(long
The number of characters to skip
n)

Overrides java.io.Reader.skip.

Skips characters.

Inherited from java.io.Reader:
nullReaderreadtransferTo

Field Detail

mConfigback to summary
pack-priv final ReaderConfig mConfig
mDataback to summary
pack-priv char[] mData

This buffer contains the partially read remains left over after bootstrapper has consumed xml declaration (if one found). It is generally recycled and can be returned after having been read.

mEndback to summary
pack-priv final int mEnd
mInback to summary
pack-priv final Reader mIn
mPtrback to summary
pack-priv int mPtr

Constructor Detail

MergedReaderback to summary
public MergedReader(ReaderConfig cfg, Reader in, char[] buf, int start, int end)

Method Detail

closeback to summary
public void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Doc from java.io.Reader.close.

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

Annotations
@Override
Exceptions
IOException:
If an I/O error occurs
freeMergedBufferback to summary
private void freeMergedBuffer()
markback to summary
public void mark(int readlimit) throws IOException

Overrides java.io.Reader.mark.

Doc from java.io.Reader.mark.

Marks 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
readlimit: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.

Annotations
@Override
Exceptions
IOException:
If the stream does not support mark(), or if some other I/O error occurs
markSupportedback to summary
public boolean markSupported()

Overrides java.io.Reader.markSupported.

Doc from java.io.Reader.markSupported.

Tells whether this stream supports the mark() operation. The default implementation always returns false. Subclasses should override this method.

Returns:boolean

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

Annotations
@Override
readback to summary
public int read() throws IOException

Overrides java.io.Reader.read.

Doc from java.io.Reader.read.

Reads 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 65535 (0x00-0xffff), or -1 if the end of the stream has been reached

Annotations
@Override
Exceptions
IOException:
If an I/O error occurs
readback to summary
public int read(char[] cbuf) throws IOException

Overrides java.io.Reader.read.

Doc from java.io.Reader.read.

Reads characters into an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

If the length of cbuf is zero, then no characters are read and 0 is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1 is returned; otherwise, at least one character is read and stored into cbuf.

Parameters
cbuf:char[]

Destination buffer

Returns:int

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

Annotations
@Override
Exceptions
IOException:
If an I/O error occurs
readback to summary
public int read(char[] cbuf, int off, int len) throws IOException

Implements abstract java.io.Reader.read.

Doc from java.io.Reader.read.

Reads 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.

If len is zero, then no characters are read and 0 is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1 is returned; otherwise, at least one character is read and stored into cbuf.

Parameters
cbuf:char[]

Destination buffer

off:int

Offset at which to start storing characters

len: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

Annotations
@Override
Exceptions
IOException:
If an I/O error occurs
readyback to summary
public boolean ready() throws IOException

Overrides java.io.Reader.ready.

Doc from java.io.Reader.ready.

Tells 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.

Annotations
@Override
Exceptions
IOException:
If an I/O error occurs
resetback to summary
public void reset() throws IOException

Overrides java.io.Reader.reset.

Doc from java.io.Reader.reset.

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

Annotations
@Override
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
skipback to summary
public long skip(long n) throws IOException

Overrides java.io.Reader.skip.

Doc from java.io.Reader.skip.

Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned.

Parameters
n:long

The number of characters to skip

Returns:long

The number of characters actually skipped

Annotations
@Override
Exceptions
IOException:
If an I/O error occurs