org.opendaylight.mdsal.binding.dom.codec.gen.impl

Class StreamWriterGenerator

java.lang.Object

org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator

All Implemented Interfaces:

DataObjectSerializerGenerator

public final class StreamWriterGenerator
extends Object

Concrete implementation of AbstractStreamWriterGenerator which in runtime generates classes implementing DataObjectSerializerImplementation interface and are used to serialize Binding DataObject.

Actual implementation of codecs is done via static methods, which allows for static wiring of codecs. Choice codec and Augmentable codecs are static properties of parent codec and stateless implementations are used (ChoiceDispatchSerializer, AugmentableDispatchSerializer), which uses registry to dispatch to concrete item codec.

Field Summary

Fields

Modifier and Type	Field and Description
protected static AugmentableDispatchSerializer	AUGMENTABLE
protected static String	SERIALIZE_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
static DataObjectSerializerGenerator	create(JavassistUtils utils) Create a new instance backed by a specific JavassistUtils instance.
protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource	generateCaseSerializer(GeneratedType type, org.opendaylight.yangtools.yang.model.api.CaseSchemaNode node) Generates serializer source for supplied case node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.
protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource	generateContainerSerializer(GeneratedType type, org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode node) Generates serializer source code for supplied container node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.
protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource	generateMapEntrySerializer(GeneratedType type, org.opendaylight.yangtools.yang.model.api.ListSchemaNode node) Generates serializer source for supplied list node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.
protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource	generateNotificationSerializer(GeneratedType type, org.opendaylight.yangtools.yang.model.api.NotificationDefinition node) Generates serializer source for notification node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.
protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource	generateSerializer(GeneratedType type, org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode schema) Generates serializer source for supplied augmentation node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.
protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource	generateUnkeyedListEntrySerializer(GeneratedType type, org.opendaylight.yangtools.yang.model.api.ListSchemaNode node) Generates serializer source for supplied list node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.
DataObjectSerializerImplementation	getSerializer(Class<?> type) Get a serializer for a particular type.
protected String	loadSerializerFor(Class<?> cls) Ensure that the serializer class for specified class is loaded and return its name.
void	onBindingRuntimeContextUpdated(BindingRuntimeContext runtime) Notify the generator that the runtime context has been updated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERIALIZE_METHOD_NAME

protected static final String SERIALIZE_METHOD_NAME

See Also:

Constant Field Values

AUGMENTABLE

protected static final AugmentableDispatchSerializer AUGMENTABLE

Method Detail

create

public static DataObjectSerializerGenerator create(JavassistUtils utils)

Create a new instance backed by a specific JavassistUtils instance.

Parameters:

utils - JavassistUtils instance to use

Returns:

A new generator

generateContainerSerializer

protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource generateContainerSerializer(GeneratedType type,
                                                                                                                   org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode node)

Generates serializer source code for supplied container node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.

Implementation is required to recursively invoke events for all reachable binding objects.

Parameters:

type - Binding type of container

node - Schema of container

Returns:

Source for container node writer

generateNotificationSerializer

protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource generateNotificationSerializer(GeneratedType type,
                                                                                                                      org.opendaylight.yangtools.yang.model.api.NotificationDefinition node)

Generates serializer source for notification node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.

Implementation is required to recursively invoke events for all reachable binding objects.

Parameters:

type - Binding type of notification

node - Schema of notification

Returns:

Source for notification node writer

generateCaseSerializer

protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource generateCaseSerializer(GeneratedType type,
                                                                                                              org.opendaylight.yangtools.yang.model.api.CaseSchemaNode node)

Generates serializer source for supplied case node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.

Implementation is required to recursively invoke events for all reachable binding objects.

Parameters:

type - Binding type of case

node - Schema of case

Returns:

Source for case node writer

generateUnkeyedListEntrySerializer

protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource generateUnkeyedListEntrySerializer(GeneratedType type,
                                                                                                                          org.opendaylight.yangtools.yang.model.api.ListSchemaNode node)

Generates serializer source for supplied list node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.

Implementation is required to recursively invoke events for all reachable binding objects.

Parameters:

type - Binding type of list

node - Schema of list

Returns:

Source for list node writer

generateSerializer

protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource generateSerializer(GeneratedType type,
                                                                                                          org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode schema)

Generates serializer source for supplied augmentation node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.

Implementation is required to recursively invoke events for all reachable binding objects.

Parameters:

type - Binding type of augmentation

schema - Schema of augmentation

Returns:

Source for augmentation node writer

generateMapEntrySerializer

protected org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerSource generateMapEntrySerializer(GeneratedType type,
                                                                                                                  org.opendaylight.yangtools.yang.model.api.ListSchemaNode node)

Generates serializer source for supplied list node, which will read supplied binding type and invoke proper methods on supplied BindingStreamEventWriter.

Implementation is required to recursively invoke events for all reachable binding objects.

Parameters:

type - Binding type of list

node - Schema of list

Returns:

Source for list node writer

getSerializer

public final DataObjectSerializerImplementation getSerializer(Class<?> type)

Description copied from interface: DataObjectSerializerGenerator

Get a serializer for a particular type.

Specified by:

getSerializer in interface DataObjectSerializerGenerator

Parameters:

type - Type class

Returns:

Serializer instance.

onBindingRuntimeContextUpdated

public final void onBindingRuntimeContextUpdated(BindingRuntimeContext runtime)

Description copied from interface: DataObjectSerializerGenerator

Notify the generator that the runtime context has been updated.

Specified by:

onBindingRuntimeContextUpdated in interface DataObjectSerializerGenerator

Parameters:

runtime - New runtime context

loadSerializerFor

protected final String loadSerializerFor(Class<?> cls)

Ensure that the serializer class for specified class is loaded and return its name.

Parameters:

cls - Data object class

Returns:

Serializer class name