FilterInput (protostuff :: api 1.8.0 API)

java.lang.Object
- io.protostuff.FilterInput<F>

All Implemented Interfaces:

Input
```
public class FilterInput<F extends Input>
extends Object
implements Input
```
A FilterInput contains some other input, which it uses as its basic source of data.

Author:

David Yu

Date created:

Nov 11, 2009

Field Summary

Fields
Modifier and Type Field and Description

protected F input

Fields
Modifier and Type	Field and Description
`protected F`	`input`

Constructor Summary

Constructors
Constructor and Description

FilterInput(F input)

Constructors
Constructor and Description
`FilterInput(F input)`

Method Summary

All Methods Instance Methods Concrete 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()` Reads a byte array/ByteBuffer value.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - input
```
protected final F extends Input input
```
- Constructor Detail
  - FilterInput
```
public FilterInput(F input)
```
- Method Detail
  - handleUnknownField
```
public <T> void handleUnknownField(int fieldNumber,
                                   Schema<T> schema)
                            throws IOException
```
    Description copied from interface: Input
    
    The underlying implementation should handle the unknown field.
    
    Specified by:
    
    handleUnknownField in interface Input
    
    Throws:
    
    IOException
  - readFieldNumber
```
public <T> int readFieldNumber(Schema<T> schema)
                        throws IOException
```
    Description copied from interface: Input
    
    Reads the field number of a message/object tied to the given schema.
    
    Specified by:
    
    readFieldNumber in interface Input
    
    Throws:
    
    IOException
  - readBool
```
public boolean readBool()
                 throws IOException
```
    Description copied from interface: Input
    
    Reads a boolean field value.
    
    Specified by:
    
    readBool in interface Input
    
    Throws:
    
    IOException
  - readByteArray
```
public byte[] readByteArray()
                     throws IOException
```
    Description copied from interface: Input
    
    Reads a byte array field value.
    
    Specified by:
    
    readByteArray in interface Input
    
    Throws:
    
    IOException
  - readBytes
```
public ByteString readBytes()
                     throws IOException
```
    Description copied from interface: Input
    
    Reads a ByteString field value.
    
    Specified by:
    
    readBytes in interface Input
    
    Throws:
    
    IOException
  - readBytes
```
public void readBytes(ByteBuffer bb)
               throws IOException
```
    Description copied from interface: Input
    
    Reads a field value into a ByteBuffer.
    
    Specified by:
    
    readBytes in interface Input
    
    Throws:
    
    IOException
  - readDouble
```
public double readDouble()
                  throws IOException
```
    Description copied from interface: Input
    
    Reads a double field value.
    
    Specified by:
    
    readDouble in interface Input
    
    Throws:
    
    IOException
  - readEnum
```
public int readEnum()
             throws IOException
```
    Description copied from interface: Input
    
    Reads an enum(its number) field value.
    
    Specified by:
    
    readEnum in interface Input
    
    Throws:
    
    IOException
  - readFixed32
```
public int readFixed32()
                throws IOException
```
    Description copied from interface: Input
    
    Reads a fixed int(4 bytes) field value.
    
    Specified by:
    
    readFixed32 in interface Input
    
    Throws:
    
    IOException
  - readFixed64
```
public long readFixed64()
                 throws IOException
```
    Description copied from interface: Input
    
    Reads a fixed long(8 bytes) field value.
    
    Specified by:
    
    readFixed64 in interface Input
    
    Throws:
    
    IOException
  - readFloat
```
public float readFloat()
                throws IOException
```
    Description copied from interface: Input
    
    Reads a float field value.
    
    Specified by:
    
    readFloat in interface Input
    
    Throws:
    
    IOException
  - readInt32
```
public int readInt32()
              throws IOException
```
    Description copied from interface: Input
    
    Reads a variable int field value.
    
    Specified by:
    
    readInt32 in interface Input
    
    Throws:
    
    IOException
  - readInt64
```
public long readInt64()
               throws IOException
```
    Description copied from interface: Input
    
    Reads a variable long field value.
    
    Specified by:
    
    readInt64 in interface Input
    
    Throws:
    
    IOException
  - readSFixed32
```
public int readSFixed32()
                 throws IOException
```
    Description copied from interface: Input
    
    Reads a signed+fixed int(4 bytes) field value.
    
    Specified by:
    
    readSFixed32 in interface Input
    
    Throws:
    
    IOException
  - readSFixed64
```
public long readSFixed64()
                  throws IOException
```
    Description copied from interface: Input
    
    Reads a signed+fixed long(8 bytes) field value.
    
    Specified by:
    
    readSFixed64 in interface Input
    
    Throws:
    
    IOException
  - readSInt32
```
public int readSInt32()
               throws IOException
```
    Description copied from interface: Input
    
    Reads a signed int field value.
    
    Specified by:
    
    readSInt32 in interface Input
    
    Throws:
    
    IOException
  - readSInt64
```
public long readSInt64()
                throws IOException
```
    Description copied from interface: Input
    
    Reads a signed long field value.
    
    Specified by:
    
    readSInt64 in interface Input
    
    Throws:
    
    IOException
  - readString
```
public String readString()
                  throws IOException
```
    Description copied from interface: Input
    
    Reads a String field value.
    
    Specified by:
    
    readString in interface Input
    
    Throws:
    
    IOException
  - readUInt32
```
public int readUInt32()
               throws IOException
```
    Description copied from interface: Input
    
    Reads an unsigned int field value.
    
    Specified by:
    
    readUInt32 in interface Input
    
    Throws:
    
    IOException
  - readUInt64
```
public long readUInt64()
                throws IOException
```
    Description copied from interface: Input
    
    Reads an unsigned long field value.
    
    Specified by:
    
    readUInt64 in interface Input
    
    Throws:
    
    IOException
  - mergeObject
```
public <T> T mergeObject(T value,
                         Schema<T> schema)
                  throws IOException
```
    Description copied from interface: Input
    
    Merges an object(with schema) field value. The provided schema handles the deserialization for the object.
    
    Specified by:
    
    mergeObject in interface Input
    
    Throws:
    
    IOException
  - transferByteRangeTo
```
public void transferByteRangeTo(Output output,
                                boolean utf8String,
                                int fieldNumber,
                                boolean repeated)
                         throws IOException
```
    Description copied from interface: Input
    
    Transfer the byte range to the output. Capable of zero-copy transfer depending on the type of input.
    
    Specified by:
    
    transferByteRangeTo in interface Input
    
    Throws:
    
    IOException
  - readByteBuffer
```
public ByteBuffer readByteBuffer()
                          throws IOException
```
    Reads a byte array/ByteBuffer value.
    
    Specified by:
    
    readByteBuffer in interface Input
    
    Throws:
    
    IOException

Class FilterInput<F extends Input>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

input

Constructor Detail

FilterInput

Method Detail

handleUnknownField

readFieldNumber

readBool

readByteArray

readBytes

readBytes

readDouble

readEnum

readFixed32

readFixed64

readFloat

readInt32

readInt64

readSFixed32

readSFixed64

readSInt32

readSInt64

readString

readUInt32

readUInt64

mergeObject

transferByteRangeTo

readByteBuffer