org.wildfly.clustering.marshalling.protostream

Interface ProtoStreamReader

All Superinterfaces:

ProtoStreamOperation, org.infinispan.protostream.RawProtoStreamReader, org.infinispan.protostream.TagReader

All Known Implementing Classes:

DefaultProtoStreamReader

public interface ProtoStreamReader
extends ProtoStreamOperation, org.infinispan.protostream.TagReader

A TagReader with the additional ability to read an arbitrary embedded object.

Author:

Paul Ferraro

Nested Class Summary

Nested classes/interfaces inherited from interface org.wildfly.clustering.marshalling.protostream.ProtoStreamOperation

ProtoStreamOperation.Context

Method Summary

Modifier and Type	Method and Description
default ProtoStreamOperation.Context	getContext()
default Object	readAny() Reads an object of an arbitrary type from this reader.
default <T> T	readAny(Class<T> targetClass) Reads an object of an arbitrary type from this reader, cast to the specified type.
default <E extends Enum<E>> E	readEnum(Class<E> enumClass) Reads an num of the specified type from this reader.
int	readFixed32() Deprecated. Use TagReader.readSFixed32() instead.
long	readFixed64() Deprecated. Use TagReader.readSFixed64() instead.
int	readInt32() Deprecated. Use TagReader.readUInt32() or TagReader.readSInt32()
long	readInt64() Deprecated. Use TagReader.readUInt64() or TagReader.readSInt64()
<T> T	readObject(Class<T> targetClass) Reads an object of the specified type from this reader.

Methods inherited from interface org.wildfly.clustering.marshalling.protostream.ProtoStreamOperation

findMarshaller, getSerializationContext

Methods inherited from interface org.infinispan.protostream.TagReader

checkLastTagWas, isAtEnd, popLimit, pushLimit, readBool, readByteArray, readByteBuffer, readDouble, readEnum, readFloat, readSFixed32, readSFixed64, readSInt32, readSInt64, readString, readTag, readUInt32, readUInt64, skipField

Methods inherited from interface org.infinispan.protostream.RawProtoStreamReader

readRawVarint32, readRawVarint64

Method Detail

getContext

default ProtoStreamOperation.Context getContext()

readAny

default Object readAny()
                throws IOException

Reads an object of an arbitrary type from this reader.

Returns:

a supplier of the unmarshalled object

Throws:

IOException - if the object could not be read with the associated marshaller.

readAny

default <T> T readAny(Class<T> targetClass)
               throws IOException

Reads an object of an arbitrary type from this reader, cast to the specified type.

Parameters:

the - expected type

Returns:

a supplier of the unmarshalled object

Throws:

IOException - if the object could not be read with the associated marshaller.

readObject

<T> T readObject(Class<T> targetClass)
          throws IOException

Reads an object of the specified type from this reader.

Type Parameters:

T - the type of the associated marshaller

Parameters:

targetClass - the class of the associated marshaller

Returns:

the unmarshalled object

Throws:

IOException - if no marshaller is associated with the specified class, or if the object could not be read with the associated marshaller.

readEnum

default <E extends Enum<E>> E readEnum(Class<E> enumClass)
                                throws IOException

Reads an num of the specified type from this reader.

Type Parameters:

T - the type of the associated marshaller

Parameters:

targetClass - the class of the associated marshaller

Returns:

the unmarshalled enum

Throws:

IOException - if no marshaller is associated with the specified enum class, or if the enum could not be read with the associated marshaller.

readInt32

@Deprecated
int readInt32()
                   throws IOException

Deprecated. Use TagReader.readUInt32() or TagReader.readSInt32()

Deprecated to discourage use.

Specified by:

readInt32 in interface org.infinispan.protostream.RawProtoStreamReader

Specified by:

readInt32 in interface org.infinispan.protostream.TagReader

Throws:

IOException

readFixed32

@Deprecated
int readFixed32()
                     throws IOException

Deprecated. Use TagReader.readSFixed32() instead.

Deprecated to discourage use.

Specified by:

readFixed32 in interface org.infinispan.protostream.RawProtoStreamReader

Specified by:

readFixed32 in interface org.infinispan.protostream.TagReader

Throws:

IOException

readInt64

@Deprecated
long readInt64()
                    throws IOException

Deprecated. Use TagReader.readUInt64() or TagReader.readSInt64()

Deprecated to discourage use.

Specified by:

readInt64 in interface org.infinispan.protostream.RawProtoStreamReader

Specified by:

readInt64 in interface org.infinispan.protostream.TagReader

Throws:

IOException

readFixed64

@Deprecated
long readFixed64()
                      throws IOException

Deprecated. Use TagReader.readSFixed64() instead.

Deprecated to discourage use.

Specified by:

readFixed64 in interface org.infinispan.protostream.RawProtoStreamReader

Specified by:

readFixed64 in interface org.infinispan.protostream.TagReader

Throws:

IOException