SerializationContextImpl (ProtoStream - core 4.0.0.Alpha4 API)

java.lang.Object
- org.infinispan.protostream.impl.SerializationContextImpl

All Implemented Interfaces:: SerializationContext

public final class SerializationContextImpl
extends Object
implements SerializationContext

Since:: 1.0
Author:: [email protected]

Constructor Summary

Constructors
Constructor and Description

SerializationContextImpl(Configuration configuration)

Constructors
Constructor and Description
`SerializationContextImpl(Configuration configuration)`

Method Summary

All Methods Instance Methods Concrete Methods
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()`
`GenericDescriptor`	`getDescriptorByName(String fullName)`
`GenericDescriptor`	`getDescriptorByTypeId(Integer typeId)` Obtains the type name associated with a numeric type id.
`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)`
`<T> BaseMarshallerDelegate<T>`	`getMarshallerDelegate(Class<T> clazz)`
`<T> BaseMarshallerDelegate<T>`	`getMarshallerDelegate(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 fileName)` Unregisters a file.

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

- Constructor Detail
  - SerializationContextImpl
```
public SerializationContextImpl(Configuration configuration)
```
- Method Detail
  - getConfiguration
```
public Configuration getConfiguration()
```
    Specified by:
    
    getConfiguration in interface SerializationContext
  - getFileDescriptors
```
public Map<String,FileDescriptor> getFileDescriptors()
```
    Description copied from interface: SerializationContext
    
    Obtain the registered file descriptors.
    
    Specified by:
    
    getFileDescriptors in interface SerializationContext
    
    Returns:
    
    a copy of the internal map of descriptors
  - registerProtoFiles
```
public void registerProtoFiles(FileDescriptorSource source)
                        throws IOException,
                               DescriptorParserException
```
    Specified by:
    
    registerProtoFiles in interface SerializationContext
    
    Throws:
    
    IOException
    
    DescriptorParserException
  - unregisterProtoFile
```
public void unregisterProtoFile(String fileName)
```
    Description copied from interface: SerializationContext
    
    Unregisters a file. Types from dependant files are removed too.
    
    Specified by:
    
    unregisterProtoFile in interface SerializationContext
  - getMessageDescriptor
```
public Descriptor getMessageDescriptor(String fullName)
```
    Specified by:
    
    getMessageDescriptor in interface SerializationContext
  - getEnumDescriptor
```
public EnumDescriptor getEnumDescriptor(String fullName)
```
    Specified by:
    
    getEnumDescriptor in interface SerializationContext
  - registerMarshaller
```
public <T> void registerMarshaller(BaseMarshaller<T> marshaller)
```
    Description copied from interface: SerializationContext
    
    Register a type marshaller. The marshaller implementation must be stateless and thread-safe.
    
    Specified by:
    
    registerMarshaller in interface SerializationContext
    
    Type Parameters:
    
    T - the Java type of the object being handled by the marshaller
    
    Parameters:
    
    marshaller - the marshaller instance
  - canMarshall
```
public boolean canMarshall(Class clazz)
```
    Description copied from interface: SerializationContext
    
    Checks if the given type (message or enum) can be marshalled. This checks that a marshaller was registered for it.
    
    Specified by:
    
    canMarshall in interface SerializationContext
    
    Parameters:
    
    clazz - the object or enum class to check
    
    Returns:
    
    true if a marshaller exists, false otherwise
  - canMarshall
```
public boolean canMarshall(String descriptorFullName)
```
    Description copied from interface: SerializationContext
    
    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.
    
    Specified by:
    
    canMarshall in interface SerializationContext
    
    Parameters:
    
    descriptorFullName - the fully qualified name of the protobuf definition to check
    
    Returns:
    
    true if a marshaller exists, false otherwise
  - getMarshaller
```
public <T> BaseMarshaller<T> getMarshaller(String descriptorFullName)
```
    Specified by:
    
    getMarshaller in interface SerializationContext
  - getMarshaller
```
public <T> BaseMarshaller<T> getMarshaller(Class<T> clazz)
```
    Specified by:
    
    getMarshaller in interface SerializationContext
  - getMarshallerDelegate
```
public <T> BaseMarshallerDelegate<T> getMarshallerDelegate(String descriptorFullName)
```
  - getMarshallerDelegate
```
public <T> BaseMarshallerDelegate<T> getMarshallerDelegate(Class<T> clazz)
```
  - getTypeNameById
```
public String getTypeNameById(Integer typeId)
```
    Description copied from interface: SerializationContext
    
    Obtains the type name associated with a numeric type id.
    
    Specified by:
    
    getTypeNameById in interface SerializationContext
    
    Parameters:
    
    typeId - the numeric type id
    
    Returns:
    
    the fully qualified type name
  - getDescriptorByName
```
public GenericDescriptor getDescriptorByName(String fullName)
```
    Specified by:
    
    getDescriptorByName in interface SerializationContext
  - getDescriptorByTypeId
```
public GenericDescriptor getDescriptorByTypeId(Integer typeId)
```
    Description copied from interface: SerializationContext
    
    Obtains the type name associated with a numeric type id.
    
    Specified by:
    
    getDescriptorByTypeId in interface SerializationContext
    
    Parameters:
    
    typeId - the numeric type id
    
    Returns:
    
    the fully qualified type name
  - getTypeIdByName
```
public Integer getTypeIdByName(String descriptorFullName)
```
    Description copied from interface: SerializationContext
    
    Obtains the associated numeric type id, if one was defined.
    
    Specified by:
    
    getTypeIdByName in interface SerializationContext
    
    Parameters:
    
    descriptorFullName - the fully qualified type name
    
    Returns:
    
    the type id or null if no type id is associated with the type

Class SerializationContextImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SerializationContextImpl

Method Detail

getConfiguration

getFileDescriptors

registerProtoFiles

unregisterProtoFile

getMessageDescriptor

getEnumDescriptor

registerMarshaller

canMarshall

canMarshall

getMarshaller

getMarshaller

getMarshallerDelegate

getMarshallerDelegate

getTypeNameById

getDescriptorByName

getDescriptorByTypeId

getTypeIdByName