io.protostuff

Interface Input

All Known Subinterfaces:

GraphInput

All Known Implementing Classes:

FilterInput

public interface Input

An Input lets an application read primitive data types and objects from a source of data.

Author:

David Yu

Date created:

Nov 9, 2009

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	handleUnknownField(int fieldNumber, Schema<T> schema) The underlying implementation should handle the unknown field.
<T> T	mergeObject(T value, Schema<T> schema) Merges an object(with schema) field value.
boolean	readBool() Reads a boolean field value.
byte[]	readByteArray() Reads a byte array field value.
ByteBuffer	readByteBuffer()
ByteString	readBytes() Reads a ByteString field value.
void	readBytes(ByteBuffer bb) Reads a field value into a ByteBuffer.
double	readDouble() Reads a double field value.
int	readEnum() Reads an enum(its number) field value.
<T> int	readFieldNumber(Schema<T> schema) Reads the field number of a message/object tied to the given schema.
int	readFixed32() Reads a fixed int(4 bytes) field value.
long	readFixed64() Reads a fixed long(8 bytes) field value.
float	readFloat() Reads a float field value.
int	readInt32() Reads a variable int field value.
long	readInt64() Reads a variable long field value.
int	readSFixed32() Reads a signed+fixed int(4 bytes) field value.
long	readSFixed64() Reads a signed+fixed long(8 bytes) field value.
int	readSInt32() Reads a signed int field value.
long	readSInt64() Reads a signed long field value.
String	readString() Reads a String field value.
int	readUInt32() Reads an unsigned int field value.
long	readUInt64() Reads an unsigned long field value.
void	transferByteRangeTo(Output output, boolean utf8String, int fieldNumber, boolean repeated) Transfer the byte range to the output.

Method Detail

handleUnknownField

<T> void handleUnknownField(int fieldNumber,
                          Schema<T> schema)
                        throws IOException

The underlying implementation should handle the unknown field.

Throws:

IOException

readFieldNumber

<T> int readFieldNumber(Schema<T> schema)
                    throws IOException

Reads the field number of a message/object tied to the given schema.

Throws:

IOException

readInt32

int readInt32()
              throws IOException

Reads a variable int field value.

Throws:

IOException

readUInt32

int readUInt32()
               throws IOException

Reads an unsigned int field value.

Throws:

IOException

readSInt32

int readSInt32()
               throws IOException

Reads a signed int field value.

Throws:

IOException

readFixed32

int readFixed32()
                throws IOException

Reads a fixed int(4 bytes) field value.

Throws:

IOException

readSFixed32

int readSFixed32()
                 throws IOException

Reads a signed+fixed int(4 bytes) field value.

Throws:

IOException

readInt64

long readInt64()
               throws IOException

Reads a variable long field value.

Throws:

IOException

readUInt64

long readUInt64()
                throws IOException

Reads an unsigned long field value.

Throws:

IOException

readSInt64

long readSInt64()
                throws IOException

Reads a signed long field value.

Throws:

IOException

readFixed64

long readFixed64()
                 throws IOException

Reads a fixed long(8 bytes) field value.

Throws:

IOException

readSFixed64

long readSFixed64()
                  throws IOException

Reads a signed+fixed long(8 bytes) field value.

Throws:

IOException

readFloat

float readFloat()
                throws IOException

Reads a float field value.

Throws:

IOException

readDouble

double readDouble()
                  throws IOException

Reads a double field value.

Throws:

IOException

readBool

boolean readBool()
                 throws IOException

Reads a boolean field value.

Throws:

IOException

readEnum

int readEnum()
             throws IOException

Reads an enum(its number) field value.

Throws:

IOException

readString

String readString()
                  throws IOException

Reads a String field value.

Throws:

IOException

readBytes

ByteString readBytes()
                     throws IOException

Reads a ByteString field value.

Throws:

IOException

readBytes

void readBytes(ByteBuffer bb)
               throws IOException

Reads a field value into a ByteBuffer.

Throws:

IOException

readByteArray

byte[] readByteArray()
                     throws IOException

Reads a byte array field value.

Throws:

IOException

readByteBuffer

ByteBuffer readByteBuffer()
                          throws IOException

Throws:

IOException

mergeObject

<T> T mergeObject(T value,
                Schema<T> schema)
              throws IOException

Merges an object(with schema) field value. The provided schema handles the deserialization for the object.

Throws:

IOException

transferByteRangeTo

void transferByteRangeTo(Output output,
                       boolean utf8String,
                       int fieldNumber,
                       boolean repeated)
                         throws IOException

Transfer the byte range to the output. Capable of zero-copy transfer depending on the type of input.

Throws:

IOException