public interface ODataSerializer
| Modifier and Type | Field and Description |
|---|---|
static String |
DEFAULT_CHARSET
The default character set is UTF-8.
|
| Modifier and Type | Method and Description |
|---|---|
SerializerResult |
complex(ServiceMetadata metadata,
EdmComplexType type,
Property property,
ComplexSerializerOptions options)
Writes complex-type instance data into an InputStream.
|
SerializerResult |
complexCollection(ServiceMetadata metadata,
EdmComplexType type,
Property property,
ComplexSerializerOptions options)
Writes data of a collection of complex-type instances into an InputStream.
|
SerializerResult |
entity(ServiceMetadata metadata,
EdmEntityType entityType,
Entity entity,
EntitySerializerOptions options)
Writes entity data into an InputStream.
|
SerializerResult |
entityCollection(ServiceMetadata metadata,
EdmEntityType entityType,
AbstractEntityCollection entitySet,
EntityCollectionSerializerOptions options)
Writes entity-collection data into an InputStream.
|
SerializerStreamResult |
entityCollectionStreamed(ServiceMetadata metadata,
EdmEntityType entityType,
EntityIterator entities,
EntityCollectionSerializerOptions options)
Writes entity-collection data into an InputStream.
|
SerializerResult |
error(ODataServerError error)
Writes an ODataError into an InputStream.
|
SerializerResult |
metadataDocument(ServiceMetadata serviceMetadata)
Writes the metadata document into an InputStream.
|
SerializerResult |
primitive(ServiceMetadata metadata,
EdmPrimitiveType type,
Property property,
PrimitiveSerializerOptions options)
Writes primitive-type instance data into an InputStream.
|
SerializerResult |
primitiveCollection(ServiceMetadata metadata,
EdmPrimitiveType type,
Property property,
PrimitiveSerializerOptions options)
Writes data of a collection of primitive-type instances into an InputStream.
|
SerializerResult |
reference(ServiceMetadata metadata,
EdmEntitySet edmEntitySet,
Entity entity,
ReferenceSerializerOptions options)
Writes a single entity reference into an InputStream.
|
SerializerResult |
referenceCollection(ServiceMetadata metadata,
EdmEntitySet edmEntitySet,
AbstractEntityCollection entityCollection,
ReferenceCollectionSerializerOptions options)
Writes entity-collection references into an InputStream.
|
SerializerResult |
serviceDocument(ServiceMetadata serviceMetadata,
String serviceRoot)
Writes the service document into an InputStream.
|
static final String DEFAULT_CHARSET
SerializerResult serviceDocument(ServiceMetadata serviceMetadata, String serviceRoot) throws SerializerException
serviceMetadata - the metadata information for the serviceserviceRoot - the service-root URI of this OData serviceSerializerExceptionSerializerResult metadataDocument(ServiceMetadata serviceMetadata) throws SerializerException
serviceMetadata - the metadata information for the serviceSerializerExceptionSerializerResult error(ODataServerError error) throws SerializerException
error - the main errorSerializerExceptionSerializerResult entityCollection(ServiceMetadata metadata, EdmEntityType entityType, AbstractEntityCollection entitySet, EntityCollectionSerializerOptions options) throws SerializerException
metadata - metadata for the serviceentityType - the EdmEntityTypeentitySet - the data of the entity setoptions - options for the serializerSerializerExceptionSerializerStreamResult entityCollectionStreamed(ServiceMetadata metadata, EdmEntityType entityType, EntityIterator entities, EntityCollectionSerializerOptions options) throws SerializerException
metadata - metadata for the serviceentityType - the EdmEntityTypeentities - the data of the entity setoptions - options for the serializerSerializerExceptionSerializerResult entity(ServiceMetadata metadata, EdmEntityType entityType, Entity entity, EntitySerializerOptions options) throws SerializerException
metadata - metadata for the serviceentityType - the EdmEntityTypeentity - the data of the entityoptions - options for the serializerSerializerExceptionSerializerResult primitive(ServiceMetadata metadata, EdmPrimitiveType type, Property property, PrimitiveSerializerOptions options) throws SerializerException
metadata - metadata for the servicetype - primitive typeproperty - property valueoptions - options for the serializerSerializerExceptionSerializerResult complex(ServiceMetadata metadata, EdmComplexType type, Property property, ComplexSerializerOptions options) throws SerializerException
metadata - metadata for the servicetype - complex typeproperty - property valueoptions - options for the serializerSerializerExceptionSerializerResult primitiveCollection(ServiceMetadata metadata, EdmPrimitiveType type, Property property, PrimitiveSerializerOptions options) throws SerializerException
metadata - metadata for the servicetype - primitive typeproperty - property valueoptions - options for the serializerSerializerExceptionSerializerResult complexCollection(ServiceMetadata metadata, EdmComplexType type, Property property, ComplexSerializerOptions options) throws SerializerException
metadata - metadata for the servicetype - complex typeproperty - property valueoptions - options for the serializerSerializerExceptionSerializerResult reference(ServiceMetadata metadata, EdmEntitySet edmEntitySet, Entity entity, ReferenceSerializerOptions options) throws SerializerException
metadata - metadata for the serviceedmEntitySet - EdmEntitySetentity - data of the entityoptions - ReferenceSerializerOptionsSerializerExceptionSerializerResult referenceCollection(ServiceMetadata metadata, EdmEntitySet edmEntitySet, AbstractEntityCollection entityCollection, ReferenceCollectionSerializerOptions options) throws SerializerException
metadata - metadata for the serviceedmEntitySet - EdmEntitySetentityCollection - data of the entity collectionoptions - ReferenceCollectionSerializerOptionsSerializerExceptionCopyright © 2013–2023 The Apache Software Foundation. All rights reserved.