Package org.infinispan.protostream.impl

Class TagReaderImpl

java.lang.Object

org.infinispan.protostream.impl.TagReaderImpl

All Implemented Interfaces:

ProtobufTagMarshaller.OperationContext, ProtobufTagMarshaller.ReadContext, TagReader

public final class TagReaderImpl
extends Object
implements TagReader, ProtobufTagMarshaller.ReadContext

Since:

3.0

Author:

[email protected]

Method Summary

Modifier and Type	Method	Description
void	checkLastTagWas(int tag)	Checks that the previously read tag is the last tag of a message or group.
byte[]	fullBufferArray()	Returns the full buffer array allowing an alternative protobuf parser to be used in marshallers, and at the root message level.
InputStream	fullBufferInputStream()	Returns the input stream allowing an alternative protobuf parser to be used in marshallers, and at the root message level.
Object	getParam(Object key)
org.infinispan.protostream.impl.ProtoStreamReaderImpl	getProtoStreamReader()
TagReader	getReader()
SerializationContextImpl	getSerializationContext()	Provides access to the ImmutableSerializationContext.
boolean	isAtEnd()	Returns true if we have reached the end of input or the limit set with pushLimit.
boolean	isInputStream()
static TagReaderImpl	newInstance(ImmutableSerializationContext serCtx, byte[] buf)
static TagReaderImpl	newInstance(ImmutableSerializationContext serCtx, byte[] buf, int offset, int length)
static TagReaderImpl	newInstance(ImmutableSerializationContext serCtx, InputStream input)
static TagReaderImpl	newInstance(ImmutableSerializationContext serCtx, ByteBuffer buf)
static TagReaderImpl	newNestedInstance(ProtobufTagMarshaller.ReadContext parent, byte[] buf)
static TagReaderImpl	newNestedInstance(ProtobufTagMarshaller.ReadContext parent, InputStream input)
void	popLimit(int oldLimit)	Returns back to a previous limit returned by pushLimit.
int	pushLimit(int limit)	Sets a limit (based on the length of the length delimited value) when entering an embedded message.
boolean	readBool()
byte[]	readByteArray()	Reads a bytes value as a byte array.
ByteBuffer	readByteBuffer()	Reads a bytes value as a ByteBuffer.
double	readDouble()
int	readEnum()
int	readFixed32()
long	readFixed64()
float	readFloat()
int	readInt32()
long	readInt64()
int	readSFixed32()
long	readSFixed64()
int	readSInt32()
long	readSInt64()
String	readString()	Reads a string value.
int	readTag()	Reads a tag and returns it or returns 0 in case the input data is finished.
int	readUInt32()
long	readUInt64()
void	setParam(Object key, Object value)
boolean	skipField(int tag)	Skips a tag+value pair and returns true for normal tags but if the tag is an end group tag it returns false.

Methods inherited from class java.lang.Object

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

Method Details

newNestedInstance

public static TagReaderImpl newNestedInstance(ProtobufTagMarshaller.ReadContext parent,
 InputStream input)

newNestedInstance

public static TagReaderImpl newNestedInstance(ProtobufTagMarshaller.ReadContext parent,
 byte[] buf)

newInstance

public static TagReaderImpl newInstance(ImmutableSerializationContext serCtx,
 InputStream input)

newInstance

public static TagReaderImpl newInstance(ImmutableSerializationContext serCtx,
 ByteBuffer buf)

newInstance

public static TagReaderImpl newInstance(ImmutableSerializationContext serCtx,
 byte[] buf)

newInstance

public static TagReaderImpl newInstance(ImmutableSerializationContext serCtx,
 byte[] buf,
 int offset,
 int length)

isAtEnd

public boolean isAtEnd()
                throws IOException

Description copied from interface: TagReader

Returns true if we have reached the end of input or the limit set with pushLimit.

Specified by:

isAtEnd in interface TagReader

Throws:

IOException

readTag

public int readTag()
            throws IOException

Description copied from interface: TagReader

Reads a tag and returns it or returns 0 in case the input data is finished.

Specified by:

readTag in interface TagReader

Throws:

IOException

checkLastTagWas

public void checkLastTagWas(int tag)
                     throws IOException

Description copied from interface: TagReader

Checks that the previously read tag is the last tag of a message or group. The expected tag should be either 0 or an end group tag.

Specified by:

checkLastTagWas in interface TagReader

Throws:

IOException

skipField

public boolean skipField(int tag)
                  throws IOException

Description copied from interface: TagReader

Skips a tag+value pair and returns true for normal tags but if the tag is an end group tag it returns false.

Specified by:

skipField in interface TagReader

Throws:

IOException

readUInt64

public long readUInt64()
                throws IOException

Specified by:

readUInt64 in interface TagReader

Throws:

IOException

readInt64

public long readInt64()
               throws IOException

Specified by:

readInt64 in interface TagReader

Throws:

IOException

readInt32

public int readInt32()
              throws IOException

Specified by:

readInt32 in interface TagReader

Throws:

IOException

readFixed64

public long readFixed64()
                 throws IOException

Specified by:

readFixed64 in interface TagReader

Throws:

IOException

readFixed32

public int readFixed32()
                throws IOException

Specified by:

readFixed32 in interface TagReader

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface TagReader

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface TagReader

Throws:

IOException

readBool

public boolean readBool()
                 throws IOException

Specified by:

readBool in interface TagReader

Throws:

IOException

readString

public String readString()
                  throws IOException

Description copied from interface: TagReader

Reads a string value.

Specified by:

readString in interface TagReader

Throws:

IOException

readByteArray

public byte[] readByteArray()
                     throws IOException

Description copied from interface: TagReader

Reads a bytes value as a byte array.

Specified by:

readByteArray in interface TagReader

Throws:

IOException

readByteBuffer

public ByteBuffer readByteBuffer()
                          throws IOException

Description copied from interface: TagReader

Reads a bytes value as a ByteBuffer.

Specified by:

readByteBuffer in interface TagReader

Throws:

IOException

readUInt32

public int readUInt32()
               throws IOException

Specified by:

readUInt32 in interface TagReader

Throws:

IOException

readEnum

public int readEnum()
             throws IOException

Specified by:

readEnum in interface TagReader

Throws:

IOException

readSFixed32

public int readSFixed32()
                 throws IOException

Specified by:

readSFixed32 in interface TagReader

Throws:

IOException

readSFixed64

public long readSFixed64()
                  throws IOException

Specified by:

readSFixed64 in interface TagReader

Throws:

IOException

readSInt32

public int readSInt32()
               throws IOException

Specified by:

readSInt32 in interface TagReader

Throws:

IOException

readSInt64

public long readSInt64()
                throws IOException

Specified by:

readSInt64 in interface TagReader

Throws:

IOException

pushLimit

public int pushLimit(int limit)
              throws IOException

Description copied from interface: TagReader

Sets a limit (based on the length of the length delimited value) when entering an embedded message.

Specified by:

pushLimit in interface TagReader

Returns:

the previous limit.

Throws:

IOException

popLimit

public void popLimit(int oldLimit)

Description copied from interface: TagReader

Returns back to a previous limit returned by pushLimit.

Specified by:

popLimit in interface TagReader

getSerializationContext

public SerializationContextImpl getSerializationContext()

Description copied from interface: ProtobufTagMarshaller.OperationContext

Provides access to the ImmutableSerializationContext.

Specified by:

getSerializationContext in interface ProtobufTagMarshaller.OperationContext

getParam

public Object getParam(Object key)

Specified by:

getParam in interface ProtobufTagMarshaller.OperationContext

setParam

public void setParam(Object key,
 Object value)

Specified by:

setParam in interface ProtobufTagMarshaller.OperationContext

getReader

public TagReader getReader()

Specified by:

getReader in interface ProtobufTagMarshaller.ReadContext

fullBufferArray

public byte[] fullBufferArray()
                       throws IOException

Description copied from interface: TagReader

Returns the full buffer array allowing an alternative protobuf parser to be used in marshallers, and at the root message level. This should not be mixed with the other tag reader read***() methods, or else an IllegalStateException will be thrown. Therefore you cannot mix protostream annotated models with other parsers reading the raw payload array.

Specified by:

fullBufferArray in interface TagReader

Throws:

IOException

fullBufferInputStream

public InputStream fullBufferInputStream()
                                  throws IOException

Description copied from interface: TagReader

Returns the input stream allowing an alternative protobuf parser to be used in marshallers, and at the root message level. This should not be mixed with the other tag reader read***() methods, or else an IllegalStateException will be thrown. Therefore you cannot mix protostream annotated models with other parsers reading the raw payload input stream.

Specified by:

fullBufferInputStream in interface TagReader

Throws:

IOException

isInputStream

public boolean isInputStream()

Specified by:

isInputStream in interface TagReader

Returns:

Returns true if the original payload is InputStream based.

getProtoStreamReader

public org.infinispan.protostream.impl.ProtoStreamReaderImpl getProtoStreamReader()