com.google.protobuf

Class ByteInput

java.lang.Object

com.google.protobuf.ByteInput

@ExperimentalApi
public abstract class ByteInput
extends Object

An input for raw bytes. This is similar to an InputStream but it is offset addressable. All the read APIs are relative.

Constructor Summary

Constructors

Constructor and Description
ByteInput()

Method Summary

Modifier and Type	Method and Description
abstract byte	read(int offset) Reads a single byte from the given offset.
int	read(int offset, byte[] b) Reads bytes of data from the given offset into an array of bytes.
abstract int	read(int offset, byte[] out, int outOffset, int len) Reads up to len bytes of data from the given offset into an array of bytes.
abstract int	read(int offset, ByteBuffer out) Reads bytes of data from the given offset into given ByteBuffer.
abstract int	size()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ByteInput

public ByteInput()

Method Detail

read

public abstract byte read(int offset)

Reads a single byte from the given offset.

Parameters:

offset - The offset from where byte to be read

Returns:

The byte of data at given offset

read

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

Reads bytes of data from the given offset into an array of bytes.

Parameters:

offset - The src offset within this ByteInput from where data to be read.

out - Destination byte array to read data into.

Returns:

The number of bytes read from ByteInput

Throws:

IOException

read

public abstract int read(int offset,
                         byte[] out,
                         int outOffset,
                         int len)

Reads up to len bytes of data from the given offset into an array of bytes.

Parameters:

offset - The src offset within this ByteInput from where data to be read.

out - Destination byte array to read data into.

outOffset - Offset within the the out byte[] where data to be read into.

len - The number of bytes to read.

Returns:

The number of bytes read from ByteInput

read

public abstract int read(int offset,
                         ByteBuffer out)

Reads bytes of data from the given offset into given ByteBuffer.

Parameters:

offset - he src offset within this ByteInput from where data to be read.

out - Destination ByteBuffer to read data into.

Returns:

The number of bytes read from ByteInput

size

public abstract int size()

Returns:

Total number of bytes in this ByteInput.