public class WrapperBufferInput extends Base implements ReadBuffer.BufferInput
Base.LoggingWriter, Base.StackFrame
Constructor and Description |
---|
WrapperBufferInput(DataInput in)
Construct a WrapperBufferInput that will read from the specified object implementing the DataInput interface.
|
WrapperBufferInput(DataInput in, ReadBuffer rb)
Construct a WrapperBufferInput that will read from the specified object implementing the DataInput interface and return the optional ReadBuffer as its underlying source.
|
Modifier and Type | Method and Description |
---|---|
int |
available()
Returns the number of bytes that can be read (or skipped over) from this input stream without causing a blocking I/O condition to occur.
|
void |
close()
Close the InputStream and release any system resources associated with it.
|
ReadBuffer |
getBuffer()
Get the ReadBuffer object that this BufferInput is reading from.
|
DataInput |
getDataInput()
Obtain the underlying object providing the DataInput interface that this object is delegating to.
|
int |
getOffset()
Determine the current offset of this BufferInput within the underlying ReadBuffer.
|
void |
mark(int cbReadLimit)
Marks the current read position in the InputStream in order to support the stream to be later "rewound" (using the
InputStreaming.reset() method) to the current position. |
boolean |
markSupported()
Determine if this InputStream supports the
ReadBuffer.BufferInput.mark(int) and InputStreaming.reset() methods. |
int |
read()
Read the next byte of data from the InputStream.
|
int |
read(byte[] ab)
Read some number of bytes from the input stream and store them into the passed array
ab . |
int |
read(byte[] ab, int of, int cb)
Read up to
cb bytes from the input stream and store them into the passed array ab starting at offset of . |
boolean |
readBoolean()
Read a boolean value.
|
ReadBuffer |
readBuffer(int cb)
Read
cb bytes and return them as a ReadBuffer object. |
byte |
readByte()
Read a byte value.
|
char |
readChar()
Read a char value.
|
double |
readDouble()
Read a double value.
|
float |
readFloat()
Read a float value.
|
void |
readFully(byte[] ab)
Read
ab.length bytes and store them in ab . |
void |
readFully(byte[] ab, int of, int cb)
Read
cb bytes and store them in ab starting at offset of . |
int |
readInt()
Read an int value.
|
String |
readLine()
Reads the next "line" of text.
|
long |
readLong()
Read a long value.
|
int |
readPackedInt()
Read an int value using a variable-length storage format as described by
WriteBuffer.BufferOutput.writePackedInt(int) . |
long |
readPackedLong()
Read a long value using a variable-length storage format as described by
WriteBuffer.BufferOutput.writePackedLong(long) . |
String |
readSafeUTF()
Read a variable-length encoded UTF packed String.
|
short |
readShort()
Read a short value.
|
int |
readUnsignedByte()
Read an unsigned byte value.
|
int |
readUnsignedShort()
Read an unsigned short value.
|
String |
readUTF()
Reads a String value.
|
void |
reset()
Rewind this stream to the position at the time the
InputStreaming.mark(int) method was last called on this InputStream. |
void |
setOffset(int of)
Specify the offset of the next byte to read from the underlying ReadBuffer.
|
long |
skip(long cb)
Skips over up to the specified number of bytes of data from this InputStream.
|
int |
skipBytes(int cb)
Skips over up to the specified number of bytes of data.
|
azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait
public WrapperBufferInput(DataInput in)
in
- an object implementing DataInput to read frompublic WrapperBufferInput(DataInput in, ReadBuffer rb)
in
- an object implementing DataInput to read fromrb
- an optional object implementing ReadBufferpublic int read() throws IOException
int
in the range 0
to 255
. If the end of the stream has been reached, the value -1
is returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
read
in interface com.oracle.common.io.InputStreaming
-1
if the end of the stream has been reachedIOException
- if an I/O error occurspublic int read(byte[] ab) throws IOException
ab
. The number of bytes actually read is returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
read
in interface com.oracle.common.io.InputStreaming
ab
- the array to store the bytes which are read from the stream-1
if no bytes were read from the stream because the end of the stream had been reachedIOException
- if an I/O error occurspublic int read(byte[] ab, int of, int cb) throws IOException
cb
bytes from the input stream and store them into the passed array ab
starting at offset of
. The number of bytes actually read is returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
read
in interface com.oracle.common.io.InputStreaming
ab
- the array to store the bytes which are read from the streamof
- the offset into the array that the read bytes will be storedcb
- the maximum number of bytes to read-1
if no bytes were read from the stream because the end of the stream had been reachedIOException
- if an I/O error occurspublic long skip(long cb) throws IOException
skip
in interface com.oracle.common.io.InputStreaming
cb
- the maximum number of bytes to skip overIOException
- if an I/O error occurspublic int available() throws IOException
BufferInput implementations must implement this method to return the extent of the buffer that has not yet been read; in other words, the entire un-read portion of the buffer must be available.
available
in interface com.oracle.common.io.InputStreaming
available
in interface ReadBuffer.BufferInput
IOException
- if an I/O error occurspublic void close() throws IOException
BufferInput implementations do not pass this call down onto an underlying stream, if any.
close
in interface com.oracle.common.io.InputStreaming
close
in interface ReadBuffer.BufferInput
IOException
- if an I/O error occurspublic void mark(int cbReadLimit)
InputStreaming.reset()
method) to the current position. The caller passes in the maximum number of bytes that it expects to read before calling the InputStreaming.reset()
method, thus indicating the upper bounds of the responsibility of the stream to be able to buffer what it has read in order to support this functionality.
BufferInput implementations ignore the cbReadLimit
; they must support an unlimited read limit, since they appear to the user as an input stream on top of a fully realized read buffer.
mark
in interface com.oracle.common.io.InputStreaming
mark
in interface ReadBuffer.BufferInput
cbReadLimit
- the maximum number of bytes that caller expects the InputStream to be able to read before the mark position becomes invalidpublic void reset() throws IOException
InputStreaming.mark(int)
method was last called on this InputStream. If the InputStream cannot fulfill this contract, it should throw an IOException.reset
in interface com.oracle.common.io.InputStreaming
IOException
- if an I/O error occurs, for example if this has not been marked or if the mark has been invalidatedpublic boolean markSupported()
ReadBuffer.BufferInput.mark(int)
and InputStreaming.reset()
methods.
BufferInput implementations must support the ReadBuffer.BufferInput.mark(int)
and InputStreaming.reset()
methods, so this method always returns true
.
markSupported
in interface com.oracle.common.io.InputStreaming
markSupported
in interface ReadBuffer.BufferInput
true
if this InputStream supports the mark and reset method; false
otherwisepublic void readFully(byte[] ab) throws IOException
ab.length
bytes and store them in ab
.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
readFully
in interface ReadBuffer.BufferInput
readFully
in interface DataInput
ab
- the array to store the bytes which are read from the streamEOFException
- if the stream is exhausted before the number of bytes indicated by the array length could be readIOException
- if an I/O error occurspublic void readFully(byte[] ab, int of, int cb) throws IOException
cb
bytes and store them in ab
starting at offset of
.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
readFully
in interface ReadBuffer.BufferInput
readFully
in interface DataInput
ab
- the array to store the bytes which are read from the streamof
- the offset into the array that the read bytes will be storedcb
- the maximum number of bytes to readEOFException
- if the stream is exhausted before the number of bytes indicated by the array length could be readIOException
- if an I/O error occurspublic int skipBytes(int cb) throws IOException
skipBytes
in interface ReadBuffer.BufferInput
skipBytes
in interface DataInput
cb
- the maximum number of bytes to skip overIOException
- if an I/O error occurspublic boolean readBoolean() throws IOException
This method is the counterpart for the DataOutput.writeBoolean(boolean)
method.
readBoolean
in interface ReadBuffer.BufferInput
readBoolean
in interface DataInput
true
or false
EOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic byte readByte() throws IOException
This method is the counterpart for the DataOutput.writeByte(int)
method.
readByte
in interface ReadBuffer.BufferInput
readByte
in interface DataInput
byte
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic int readUnsignedByte() throws IOException
This method is the counterpart for the DataOutput.writeByte(int)
method when it is used with unsigned 8-bit values.
readUnsignedByte
in interface ReadBuffer.BufferInput
readUnsignedByte
in interface DataInput
int
value in the range 0x00 to 0xFFEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic short readShort() throws IOException
This method is the counterpart for the DataOutput.writeShort(int)
method.
readShort
in interface ReadBuffer.BufferInput
readShort
in interface DataInput
short
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic int readUnsignedShort() throws IOException
This method is the counterpart for the DataOutput.writeShort(int)
method when it is used with unsigned 16-bit values.
readUnsignedShort
in interface ReadBuffer.BufferInput
readUnsignedShort
in interface DataInput
int
value in the range of 0x0000 to 0xFFFFEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic char readChar() throws IOException
This method is the counterpart for the DataOutput.writeChar(int)
method.
readChar
in interface ReadBuffer.BufferInput
readChar
in interface DataInput
char
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic int readInt() throws IOException
This method is the counterpart for the DataOutput.writeInt(int)
method.
readInt
in interface ReadBuffer.BufferInput
readInt
in interface DataInput
int
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic long readLong() throws IOException
This method is the counterpart for the DataOutput.writeLong(long)
method.
readLong
in interface ReadBuffer.BufferInput
readLong
in interface DataInput
long
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic float readFloat() throws IOException
This method is the counterpart for the DataOutput.writeFloat(float)
method.
readFloat
in interface ReadBuffer.BufferInput
readFloat
in interface DataInput
float
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic double readDouble() throws IOException
This method is the counterpart for the DataOutput.writeDouble(double)
method.
readDouble
in interface ReadBuffer.BufferInput
readDouble
in interface DataInput
double
valueEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic String readLine() throws IOException
This method does not have a counterpart in the DataOutput
interface. Furthermore, this method is defined as operating on bytes and not on characters, and thus it should be selected for use only after careful consideration, as if it were deprecated (which it has been in java.io.DataInputStream).
readLine
in interface ReadBuffer.BufferInput
readLine
in interface DataInput
IOException
- if an I/O error occurs.public String readUTF() throws IOException
This method is the counterpart for the DataOutput.writeUTF(java.lang.String)
method.
readUTF
in interface ReadBuffer.BufferInput
readUTF
in interface DataInput
UTFDataFormatException
- if the bytes that were read were not a valid UTF-8 encoded stringEOFException
- if the value could not be read because no more data remains to be readIOException
- if an I/O error occurspublic ReadBuffer getBuffer()
getBuffer
in interface ReadBuffer.BufferInput
public String readSafeUTF() throws IOException
readSafeUTF
in interface ReadBuffer.BufferInput
IOException
- if an I/O error occurspublic int readPackedInt() throws IOException
WriteBuffer.BufferOutput.writePackedInt(int)
.readPackedInt
in interface ReadBuffer.BufferInput
IOException
- if an I/O error occurspublic long readPackedLong() throws IOException
WriteBuffer.BufferOutput.writePackedLong(long)
.readPackedLong
in interface ReadBuffer.BufferInput
IOException
- if an I/O error occurspublic ReadBuffer readBuffer(int cb) throws IOException
cb
bytes and return them as a ReadBuffer object.readBuffer
in interface ReadBuffer.BufferInput
cb
- the number of bytes to readcb
bytes read from the BufferInputEOFException
- if the stream is exhausted before the number of bytes indicated could be readIOException
- if an I/O error occurspublic int getOffset()
getOffset
in interface ReadBuffer.BufferInput
public void setOffset(int of)
setOffset
in interface ReadBuffer.BufferInput
of
- the offset of the next byte to read from the ReadBufferpublic DataInput getDataInput()