org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.base

Class BindingCodecContext

java.lang.Object

org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.base.BindingCodecContext

All Implemented Interfaces:

BindingTreeCodec, NodeCodecContext.CodecContextFactory, org.opendaylight.yangtools.concepts.Immutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Immutable>

@Beta
public final class BindingCodecContext
extends Object
implements NodeCodecContext.CodecContextFactory, BindingTreeCodec, org.opendaylight.yangtools.concepts.Immutable

Binding codec context for holding runtime part and codecs.

Constructor Summary

Constructors

Constructor and Description
BindingCodecContext(BindingRuntimeContext context, BindingNormalizedNodeCodecRegistry registry) Prepare runtime context and codec registry.

Method Summary

Modifier and Type	Method and Description
org.opendaylight.yangtools.concepts.Codec<DOMSource,Document>	getAnyxmlCodec() Get anyxml codec.
com.google.common.collect.ImmutableMap<String,AnyxmlNodeCodecContext<?>>	getAnyxmlNodes(Class<?> parentClass, org.opendaylight.yangtools.yang.model.api.DataNodeContainer childSchema) Returns anyxml nodes for supplied data container and parent class.
org.opendaylight.yangtools.concepts.Codec<Object,Object>	getCodec(Class<?> valueType, org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> instantiatedType) Get specific codec for binding class by type.
DataContainerCodecContext<?,?>	getCodecContextNode(InstanceIdentifier<?> binding, List<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> builder) Prepare context from Binding and DOM path.
NodeCodecContext<?>	getCodecContextNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom, Collection<TreeArgument<?>> bindingArguments) Multi-purpose utility function.
TreeNodeSerializer	getEventStreamSerializer(Class<?> type)
org.opendaylight.yangtools.concepts.Codec<org.opendaylight.yangtools.yang.common.QName,Class<?>>	getIdentityCodec() Get identity codec.
org.opendaylight.yangtools.concepts.Codec<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,InstanceIdentifier<?>>	getInstanceIdentifierCodec() Get instance identifier codec.
com.google.common.collect.ImmutableMap<String,LeafNodeCodecContext<?>>	getLeafNodes(Class<?> parentClass, org.opendaylight.yangtools.yang.model.api.DataNodeContainer childSchema) Returns leaf nodes for supplied data container and parent class.
NotificationCodecContext<?>	getNotificationContext(org.opendaylight.yangtools.yang.model.api.SchemaPath notification) Get notification codec according to notification schema path.
OperationInputCodec<?>	getOperationInputCodec(org.opendaylight.yangtools.yang.model.api.SchemaPath path) Get operation input codec.
org.opendaylight.yangtools.concepts.Codec<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates,IdentifiableItem<?,?>>	getPathArgumentCodec(Class<?> listClz, org.opendaylight.yangtools.yang.model.api.ListSchemaNode schema) Returns Path argument codec for list item.
BindingRuntimeContext	getRuntimeContext() Returns immutable runtime context associated with this factory.
<T extends TreeNode> BindingTreeNodeCodec<T>	getSubtreeCodec(InstanceIdentifier<T> path) Get specific subtree serialization context by Binding path.
BindingTreeNodeCodec<?>	getSubtreeCodec(org.opendaylight.yangtools.yang.model.api.SchemaPath path) Get specific subtree serialization context by SchemaPath path.
BindingTreeNodeCodec<?>	getSubtreeCodec(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) Get specific subtree serialization context by DOM path.
BindingStreamEventWriter	newNotificationWriter(Class<? extends Notification> notification, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)
BindingStreamEventWriter	newOperationWriter(Class<? extends Instantiable<?>> operationInputOrOutput, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Prepare specific writer for operations.
Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,BindingStreamEventWriter>	newWriter(InstanceIdentifier<?> path, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Prepare specific writer for binding path.
BindingStreamEventWriter	newWriterWithoutIdentifier(InstanceIdentifier<?> path, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Prepare specific writer for binding path without DOM identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingCodecContext

public BindingCodecContext(BindingRuntimeContext context,
                           BindingNormalizedNodeCodecRegistry registry)

Prepare runtime context and codec registry.

Parameters:

context - - runtime context

registry - - binding normalized node codec registry

Method Detail

getRuntimeContext

public BindingRuntimeContext getRuntimeContext()

Description copied from interface: NodeCodecContext.CodecContextFactory

Returns immutable runtime context associated with this factory.

Specified by:

getRuntimeContext in interface NodeCodecContext.CodecContextFactory

Returns:

runtime context

getInstanceIdentifierCodec

public org.opendaylight.yangtools.concepts.Codec<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,InstanceIdentifier<?>> getInstanceIdentifierCodec()

Get instance identifier codec.

Returns:

instance identifier codec

getIdentityCodec

public org.opendaylight.yangtools.concepts.Codec<org.opendaylight.yangtools.yang.common.QName,Class<?>> getIdentityCodec()

Get identity codec.

Returns:

identity codec

getAnyxmlCodec

public org.opendaylight.yangtools.concepts.Codec<DOMSource,Document> getAnyxmlCodec()

Get anyxml codec.

Returns:

anyxml codec

getEventStreamSerializer

public TreeNodeSerializer getEventStreamSerializer(Class<?> type)

Specified by:

getEventStreamSerializer in interface NodeCodecContext.CodecContextFactory

newWriter

public Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,BindingStreamEventWriter> newWriter(InstanceIdentifier<?> path,
                                                                                                                     org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Prepare specific writer for binding path.

Parameters:

path - - binding path

domWriter - - DOM writer

Returns:

entry of DOM path and writer

newWriterWithoutIdentifier

public BindingStreamEventWriter newWriterWithoutIdentifier(InstanceIdentifier<?> path,
                                                           org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Prepare specific writer for binding path without DOM identifier.

Parameters:

path - - binding path

domWriter - - DOM writer

Returns:

stream event writer for binding path

newOperationWriter

public BindingStreamEventWriter newOperationWriter(Class<? extends Instantiable<?>> operationInputOrOutput,
                                                   org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Prepare specific writer for operations.

Parameters:

operationInputOrOutput - - binding data

domWriter - - DOM writer

Returns:

stream event writer for operation

newNotificationWriter

public BindingStreamEventWriter newNotificationWriter(Class<? extends Notification> notification,
                                                      org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

getCodecContextNode

public DataContainerCodecContext<?,?> getCodecContextNode(InstanceIdentifier<?> binding,
                                                          List<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> builder)

Prepare context from Binding and DOM path.

Parameters:

binding - - binding path

builder - - DOM path

Returns:

context for path

getCodecContextNode

@Nullable
public NodeCodecContext<?> getCodecContextNode(@Nonnull
                                                         org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom,
                                                         @Nullable
                                                         Collection<TreeArgument<?>> bindingArguments)

Multi-purpose utility function. Traverse the codec tree, looking for the appropriate codec for the specified YangInstanceIdentifier. As a side-effect, gather all traversed binding TreeArgument into the supplied collection.

Parameters:

dom - YangInstanceIdentifier which is to be translated

bindingArguments - Collection for traversed path arguments

Returns:

Codec for target node, or @null if the node does not have a binding representation (choice, case, leaf).

getNotificationContext

public NotificationCodecContext<?> getNotificationContext(org.opendaylight.yangtools.yang.model.api.SchemaPath notification)

Get notification codec according to notification schema path.

Parameters:

notification - - schema path of notification

Returns:

notification codec context

getOperationInputCodec

public OperationInputCodec<?> getOperationInputCodec(org.opendaylight.yangtools.yang.model.api.SchemaPath path)

Get operation input codec.

Parameters:

path - - path of input data of operation

Returns:

operation input codec

getLeafNodes

public com.google.common.collect.ImmutableMap<String,LeafNodeCodecContext<?>> getLeafNodes(Class<?> parentClass,
                                                                                           org.opendaylight.yangtools.yang.model.api.DataNodeContainer childSchema)

Description copied from interface: NodeCodecContext.CodecContextFactory

Returns leaf nodes for supplied data container and parent class.

Specified by:

getLeafNodes in interface NodeCodecContext.CodecContextFactory

Parameters:

parentClass - Binding type for which leaves should be loaded.

childSchema - Instantiated schema of binding type.

Returns:

Map of local name to leaf node context.

getAnyxmlNodes

public com.google.common.collect.ImmutableMap<String,AnyxmlNodeCodecContext<?>> getAnyxmlNodes(Class<?> parentClass,
                                                                                               org.opendaylight.yangtools.yang.model.api.DataNodeContainer childSchema)

Description copied from interface: NodeCodecContext.CodecContextFactory

Returns anyxml nodes for supplied data container and parent class.

Specified by:

getAnyxmlNodes in interface NodeCodecContext.CodecContextFactory

Parameters:

parentClass - Binding type for which anyxml should be loaded.

childSchema - Instantiated schema of binding type.

Returns:

Map of local name to anyxml node context.

getCodec

public org.opendaylight.yangtools.concepts.Codec<Object,Object> getCodec(Class<?> valueType,
                                                                         org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> instantiatedType)

Get specific codec for binding class by type.

Parameters:

valueType - - binding class

instantiatedType - - type definition

Returns:

specific codec

getPathArgumentCodec

public org.opendaylight.yangtools.concepts.Codec<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates,IdentifiableItem<?,?>> getPathArgumentCodec(Class<?> listClz,
                                                                                                                                                                                          org.opendaylight.yangtools.yang.model.api.ListSchemaNode schema)

Description copied from interface: NodeCodecContext.CodecContextFactory

Returns Path argument codec for list item.

Specified by:

getPathArgumentCodec in interface NodeCodecContext.CodecContextFactory

Parameters:

listClz - Type of list item

schema - Schema of list item

Returns:

Path argument codec for supplied list item.

getSubtreeCodec

@Nullable
public <T extends TreeNode> BindingTreeNodeCodec<T> getSubtreeCodec(InstanceIdentifier<T> path)

Description copied from interface: BindingTreeCodec

Get specific subtree serialization context by Binding path.

Specified by:

getSubtreeCodec in interface BindingTreeCodec

Type Parameters:

T - data type

Parameters:

path - - InstanceIdentifier path

Returns:

subtree codec

getSubtreeCodec

@Nullable
public BindingTreeNodeCodec<?> getSubtreeCodec(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Description copied from interface: BindingTreeCodec

Get specific subtree serialization context by DOM path.

Specified by:

getSubtreeCodec in interface BindingTreeCodec

Parameters:

path - - YangInstanceIdentifier path

Returns:

subtree codec

getSubtreeCodec

@Nullable
public BindingTreeNodeCodec<?> getSubtreeCodec(org.opendaylight.yangtools.yang.model.api.SchemaPath path)

Description copied from interface: BindingTreeCodec

Get specific subtree serialization context by SchemaPath path.

Specified by:

getSubtreeCodec in interface BindingTreeCodec

Parameters:

path - - SchemaPath path

Returns:

specific subtree codec