ImmutableSerializationContext (ProtoStream

All Known Subinterfaces:

SerializationContext

All Known Implementing Classes:

SerializationContextImpl
```
public interface ImmutableSerializationContext
```
Since:

4.0

Author:

[email protected]

Method Summary

All Methods Instance Methods Abstract 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 fullName)` Checks if the given type (message or enum) can be marshalled.
`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 fullName)`
`Descriptor`	`getMessageDescriptor(String fullName)`
`Integer`	`getTypeIdByName(String fullName)` Obtains the associated numeric type id, if one was defined.
`String`	`getTypeNameById(Integer typeId)` Obtains the type name associated with a numeric type id.

- Method Detail
  - getFileDescriptors
```
Map<String,FileDescriptor> getFileDescriptors()
```
    Obtain the registered file descriptors.
    
    Returns:
    
    a copy of the internal map of descriptors
  - 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 fullName)
```
    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:
    
    fullName - the fully qualified name of the protobuf definition to check
    
    Returns:
    
    true if a marshaller exists, false otherwise
  - getMarshaller
```
<T> BaseMarshaller<T> getMarshaller(String fullName)
```
  - 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 fullName)
```
    Obtains the associated numeric type id, if one was defined.
    
    Parameters:
    
    fullName - 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
  - getDescriptorByTypeId
```
GenericDescriptor getDescriptorByTypeId(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
  - getDescriptorByName
```
GenericDescriptor getDescriptorByName(String fullName)
```

Interface ImmutableSerializationContext

Method Summary

Method Detail

getFileDescriptors

getMessageDescriptor

getEnumDescriptor

canMarshall

canMarshall

getMarshaller

getMarshaller

getTypeNameById

getTypeIdByName

getDescriptorByTypeId

getDescriptorByName