org.infinispan.protostream

Interface SerializationContext

All Known Implementing Classes:

SerializationContextImpl

public interface SerializationContext

A repository for protobuf definitions and marshallers. All marshalling operations happen in the context of a SerializationContext.

Since:

1.0

Author:

[email protected]

Method Summary

Modifier and Type	Method and Description
boolean	canMarshall(Class clazz) Checks if the given type (message or enum) can be marshalled.
boolean	canMarshall(String descriptorFullName) Checks if the given type (message or enum) can be marshalled.
Configuration	getConfiguration()
EnumDescriptor	getEnumDescriptor(String fullName)
Map<String,FileDescriptor>	getFileDescriptors() Obtain the registered file descriptors.
<T> BaseMarshaller<T>	getMarshaller(Class<T> clazz)
<T> BaseMarshaller<T>	getMarshaller(String descriptorFullName)
Descriptor	getMessageDescriptor(String fullName)
Integer	getTypeIdByName(String descriptorFullName) Obtains the associated numeric type id, if one was defined.
String	getTypeNameById(Integer typeId) Obtains the type name associated with a numeric type id.
<T> void	registerMarshaller(BaseMarshaller<T> marshaller) Register a type marshaller.
void	registerProtoFiles(FileDescriptorSource source)
void	unregisterProtoFile(String name) Unregisters a file.

Method Detail

getConfiguration

Configuration getConfiguration()

registerProtoFiles

void registerProtoFiles(FileDescriptorSource source)
                 throws IOException,
                        DescriptorParserException

Throws:

IOException

DescriptorParserException

unregisterProtoFile

void unregisterProtoFile(String name)

Unregisters a file. Types from dependant files are removed too.

getFileDescriptors

Map<String,FileDescriptor> getFileDescriptors()

Obtain the registered file descriptors.

Returns:

a copy of the internal map of descriptors

registerMarshaller

<T> void registerMarshaller(BaseMarshaller<T> marshaller)

Register a type marshaller. The marshaller implementation must be stateless and thread-safe.

Type Parameters:

T - the Java type of the object being handled by the marshaller

Parameters:

marshaller - the marshaller instance

getMessageDescriptor

Descriptor getMessageDescriptor(String fullName)

getEnumDescriptor

EnumDescriptor getEnumDescriptor(String fullName)

canMarshall

boolean canMarshall(Class clazz)

Checks if the given type (message or enum) can be marshalled. This checks that a marshaller was registered for it.

Parameters:

clazz - the object or enum class to check

Returns:

true if a marshaller exists, false otherwise

canMarshall

boolean canMarshall(String descriptorFullName)

Checks if the given type (message or enum) can be marshalled. This checks that the type name was defined and a marshaller was registered for it.

Parameters:

descriptorFullName - the fully qualified name of the protobuf definition to check

Returns:

true if a marshaller exists, false otherwise

getMarshaller

<T> BaseMarshaller<T> getMarshaller(String descriptorFullName)

getMarshaller

<T> BaseMarshaller<T> getMarshaller(Class<T> clazz)

getTypeNameById

String getTypeNameById(Integer typeId)

Obtains the type name associated with a numeric type id.

Parameters:

typeId - the numeric type id

Returns:

the fully qualified type name

Throws:

IllegalArgumentException - if the given type id is unknown

getTypeIdByName

Integer getTypeIdByName(String descriptorFullName)

Obtains the associated numeric type id, if one was defined.

Parameters:

descriptorFullName - the fully qualified type name

Returns:

the type id or null if no type id is associated with the type

Throws:

IllegalArgumentException - if the given type name is unknown