org.wildfly.clustering.marshalling.protostream

Interface Marshallable<T>

Type Parameters:

T - the type of this marshaller

All Known Subinterfaces:

FieldMarshaller<T>, ProtoStreamMarshaller<T>, ProtoStreamMarshallerProvider, ScalarMarshaller<T>, ScalarMarshallerProvider

All Known Implementing Classes:

AbstractCollectionMarshaller, AbstractMapMarshaller, AnyMarshaller, AtomicMarshallerProvider, CalendarMarshaller, ClassMarshaller, CollectionMarshaller, ConcurrentMapMarshaller, ConcurrentMarshallerProvider, ConcurrentSortedMapMarshaller, CopyOnWriteCollectionMarshaller, EnumMapMarshaller, EnumMarshaller, EnumSetMarshaller, ExceptionMarshaller, FunctionalFieldSetMarshaller, FunctionalMarshaller, FunctionalScalarMarshaller, InetSocketAddressMarshaller, InstantMarshaller, LinkedHashMapMarshaller, LoadedClassField, LocalDateTimeMarshaller, MapEntryMarshaller, MapMarshaller, MarshallingMarshallerProvider, MonthDayMarshaller, NetMarshallerProvider, OffsetDateTimeMarshaller, OffsetTimeMarshaller, OptionalMarshaller, PackedArrayMarshaller, PeriodMarshaller, ProtoStreamBuilderFieldSetMarshaller, Scalar, ScalarClass, ScalarFieldMarshaller, SimpleFieldSetMarshaller, SimpleFunctionalMarshaller, SingletonCollectionMarshaller, SingletonMapMarshaller, SortedMapMarshaller, SortedSetMarshaller, SQLMarshallerProvider, StackTraceElementMarshaller, TimeMarshallerProvider, TypedArrayMarshaller, TypedEnumMarshaller, TypedObjectMarshaller, URIMarshaller, URLMarshaller, UtilMarshallerProvider, ValueMarshaller, YearMonthMarshaller, ZonedDateTimeMarshaller

public interface Marshallable<T>

Interface inherited by marshallable components.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method and Description
Class<? extends T>	getJavaClass() Returns the type of object handled by this marshallable instance.
T	readFrom(ProtoStreamReader reader) Reads an object from the specified reader.
default OptionalInt	size(org.infinispan.protostream.ImmutableSerializationContext context, T value) Predicts the size of the specified object that would be written via the writeTo(ProtoStreamWriter, Object) method.
void	writeTo(ProtoStreamWriter writer, T value) Writes the specified object to the specified writer.

Method Detail

readFrom

T readFrom(ProtoStreamReader reader)
    throws IOException

Reads an object from the specified reader.

Parameters:

reader - a ProtoStream reader

Returns:

the read object

Throws:

IOException - if the object could not be read

writeTo

void writeTo(ProtoStreamWriter writer,
             T value)
      throws IOException

Writes the specified object to the specified writer.

Parameters:

writer - a ProtoStream writer

value - the object to be written

Throws:

IOException - if the object could not be written

size

default OptionalInt size(org.infinispan.protostream.ImmutableSerializationContext context,
                         T value)

Predicts the size of the specified object that would be written via the writeTo(ProtoStreamWriter, Object) method.

Parameters:

context - a serialization context

value - the object whose size is to be determined

Returns:

the computed size of the specified object, or empty if the size could not be determined.

getJavaClass

Class<? extends T> getJavaClass()

Returns the type of object handled by this marshallable instance.

Returns:

the type of object handled by this marshallable instance.