Protocol Buffers [Core] 3.7.1 · com.google.protobuf.IterableByteBufferInputStream

Field Summary

Modifier and Type	Field and Description
private long	currentAddress If the current ByteBuffer is unsafe-direct based, currentAddress is the start address of this ByteBuffer; otherwise should be zero.
private byte[]	currentArray If the current ByteBuffer is unsafe-direct based, currentArray is null; otherwise should be the array inside ByteBuffer.
private int	currentArrayOffset Current ByteBuffer's array offset
private ByteBuffer	currentByteBuffer The current ByteBuffer;
private int	currentByteBufferPos The current position for current ByteBuffer
private int	currentIndex Current `ByteBuffer`'s index If index equals dataSize, then all the data in the InputStream has been consumed
private int	dataSize The number of ByteBuffers in the input data.
private boolean	hasArray Whether current ByteBuffer has an array
private Iterator<ByteBuffer>	iterator The `Iterator` with type `ByteBuffer` of `input`

Access	Constructor and Description
pack-priv	IterableByteBufferInputStream(Iterable<ByteBuffer> data)

Method Summary

Modifier and Type	Method and Description
private boolean	getNextByteBuffer()
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. output, int the start offset in array `b` at which the data is written. offset, int the maximum number of bytes to read. length) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
private void	updateCurrentByteBufferPos(int numberOfBytesRead)

Inherited from java.io.InputStream:: available close mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

Field Detail

currentAddress	back to summary
private long currentAddress If the current ByteBuffer is unsafe-direct based, currentAddress is the start address of this ByteBuffer; otherwise should be zero.

currentArray	back to summary
private byte[] currentArray If the current ByteBuffer is unsafe-direct based, currentArray is null; otherwise should be the array inside ByteBuffer.

currentArrayOffset	back to summary
private int currentArrayOffset Current ByteBuffer's array offset

currentByteBuffer	back to summary
private ByteBuffer currentByteBuffer The current ByteBuffer;

currentByteBufferPos	back to summary
private int currentByteBufferPos The current position for current ByteBuffer

currentIndex back to summary

currentIndex	back to summary
private int currentIndex Current `ByteBuffer`'s index If index equals dataSize, then all the data in the InputStream has been consumed

private int currentIndex

Current ByteBuffer's index

If index equals dataSize, then all the data in the InputStream has been consumed

dataSize	back to summary
private int dataSize The number of ByteBuffers in the input data.

hasArray	back to summary
private boolean hasArray Whether current ByteBuffer has an array

iterator	back to summary
private Iterator<ByteBuffer> iterator The `Iterator` with type `ByteBuffer` of `input`

Constructor Detail

IterableByteBufferInputStream	back to summary
pack-priv IterableByteBufferInputStream(Iterable<ByteBuffer> data)

Method Detail

getNextByteBuffer	back to summary
private boolean getNextByteBuffer()

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because 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. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because 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.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] output, int offset, int length) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters output:byte[] the buffer into which the data is read. offset:int the start offset in array `b` at which the data is written. length:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public int read(byte[] output, int offset, int length) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

output:byte[]: the buffer into which the data is read.
offset:int: the start offset in array b at which the data is written.
length:int: the maximum number of bytes to read.