org.opendaylight.controller.md.sal.binding.impl

Class BindingToNormalizedNodeCodec

java.lang.Object

org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec

All Implemented Interfaces:

AutoCloseable, EventListener, org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory, org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer, org.opendaylight.yangtools.yang.model.api.SchemaContextListener

public class BindingToNormalizedNodeCodec
extends Object
implements org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory, org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer, org.opendaylight.yangtools.yang.model.api.SchemaContextListener, AutoCloseable

Constructor Summary

Constructors

Constructor and Description
BindingToNormalizedNodeCodec(org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy classLoadingStrategy, org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry codecRegistry)
BindingToNormalizedNodeCodec(org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy classLoadingStrategy, org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry codecRegistry, boolean waitForSchema)

Method Summary

Modifier and Type	Method and Description
void	close()
org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree	create(org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext context)
org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree	create(org.opendaylight.yangtools.yang.model.api.SchemaContext context, Class<?>... bindingClasses)
<T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.base.Function<com.google.common.base.Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>,com.google.common.base.Optional<T>>	deserializeFunction(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)
Map.Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>,org.opendaylight.yangtools.yang.binding.DataObject>	fromNormalizedNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)
org.opendaylight.yangtools.yang.binding.Notification	fromNormalizedNodeNotification(org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)
org.opendaylight.yangtools.yang.binding.DataObject	fromNormalizedNodeRpcData(org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>	fromYangInstanceIdentifier(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom)
org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry	getCodecFactory()
org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry	getCodecRegistry()
DataNormalizer	getDataNormalizer()
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	getDefaultNodeFor(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) Returns an default object according to YANG schema for supplied path.
Set<Class<? extends org.opendaylight.yangtools.yang.binding.Notification>>	getNotificationClasses(Set<org.opendaylight.yangtools.yang.model.api.SchemaPath> interested)
com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.RpcDefinition>	getRpcMethodToSchema(Class<? extends org.opendaylight.yangtools.yang.binding.RpcService> key)
com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.SchemaPath>	getRpcMethodToSchemaPath(Class<? extends org.opendaylight.yangtools.yang.binding.RpcService> key)
Map.Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>,org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode<?>>	getSubtreeCodec(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier domIdentifier)
void	onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
com.google.common.base.Optional<Map.Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject>,org.opendaylight.yangtools.yang.binding.DataObject>>	toBinding(Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,? extends org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> normalized)
com.google.common.base.Optional<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject>>	toBinding(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier normalized) Returns a Binding-Aware instance identifier from normalized instance-identifier if it is possible to create representation.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toNormalized(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject> binding) Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.
<T extends org.opendaylight.yangtools.yang.binding.DataObject> Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	toNormalizedNode(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path, T data)
Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	toNormalizedNode(Map.Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject>,org.opendaylight.yangtools.yang.binding.DataObject> binding) Converts Binding Map.Entry to DOM Map.Entry Same as toNormalizedNode(InstanceIdentifier, DataObject).
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeNotification(org.opendaylight.yangtools.yang.binding.Notification data)
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeRpcData(org.opendaylight.yangtools.yang.binding.DataContainer data)
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifier(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> binding)
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifierBlocking(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject> binding)
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifierCached(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> binding)

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingToNormalizedNodeCodec

public BindingToNormalizedNodeCodec(org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy classLoadingStrategy,
                                    org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry codecRegistry)

BindingToNormalizedNodeCodec

public BindingToNormalizedNodeCodec(org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy classLoadingStrategy,
                                    org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry codecRegistry,
                                    boolean waitForSchema)

Method Detail

toYangInstanceIdentifierBlocking

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toYangInstanceIdentifierBlocking(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject> binding)

toNormalized

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toNormalized(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject> binding)

Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.

Parameters:

binding - Binding Instance Identifier

Returns:

DOM Instance Identifier

Throws:

IllegalArgumentException - If supplied Instance Identifier is not valid.

toYangInstanceIdentifier

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toYangInstanceIdentifier(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> binding)

Specified by:

toYangInstanceIdentifier in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

toYangInstanceIdentifierCached

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toYangInstanceIdentifierCached(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> binding)

toNormalizedNode

public <T extends org.opendaylight.yangtools.yang.binding.DataObject> Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> toNormalizedNode(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path,
                                                                                                                                                                                                                                      T data)

Specified by:

toNormalizedNode in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

toNormalizedNode

public Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> toNormalizedNode(Map.Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject>,org.opendaylight.yangtools.yang.binding.DataObject> binding)

Converts Binding Map.Entry to DOM Map.Entry Same as toNormalizedNode(InstanceIdentifier, DataObject).

Parameters:

binding - Map Entry with InstanceIdentifier as key and DataObject as value.

Returns:

DOM Map Entry with YangInstanceIdentifier as key and NormalizedNode as value.

fromNormalizedNode

public Map.Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>,org.opendaylight.yangtools.yang.binding.DataObject> fromNormalizedNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
                                                                                                                                                      org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

Specified by:

fromNormalizedNode in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

fromNormalizedNodeNotification

public org.opendaylight.yangtools.yang.binding.Notification fromNormalizedNodeNotification(org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                                                           org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)

Specified by:

fromNormalizedNodeNotification in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

fromNormalizedNodeRpcData

public org.opendaylight.yangtools.yang.binding.DataObject fromNormalizedNodeRpcData(org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                                                    org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)

Specified by:

fromNormalizedNodeRpcData in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

fromYangInstanceIdentifier

public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> fromYangInstanceIdentifier(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom)

Specified by:

fromYangInstanceIdentifier in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

toNormalizedNodeNotification

public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeNotification(org.opendaylight.yangtools.yang.binding.Notification data)

Specified by:

toNormalizedNodeNotification in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

toNormalizedNodeRpcData

public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeRpcData(org.opendaylight.yangtools.yang.binding.DataContainer data)

Specified by:

toNormalizedNodeRpcData in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

toBinding

public com.google.common.base.Optional<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject>> toBinding(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier normalized)
                                                                                                                                                                    throws org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException

Returns a Binding-Aware instance identifier from normalized instance-identifier if it is possible to create representation. Returns Optional.absent for cases where target is mixin node except augmentation.

Throws:

org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException

getDataNormalizer

public DataNormalizer getDataNormalizer()

toBinding

public com.google.common.base.Optional<Map.Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends org.opendaylight.yangtools.yang.binding.DataObject>,org.opendaylight.yangtools.yang.binding.DataObject>> toBinding(@Nonnull
                                                                                                                                                                                                                                         Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,? extends org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> normalized)
                                                                                                                                                                                                                                  throws org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException

Throws:

org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException

onGlobalContextUpdated

public void onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

Specified by:

onGlobalContextUpdated in interface org.opendaylight.yangtools.yang.model.api.SchemaContextListener

deserializeFunction

public <T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.base.Function<com.google.common.base.Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>,com.google.common.base.Optional<T>> deserializeFunction(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)

getDefaultNodeFor

public org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> getDefaultNodeFor(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Returns an default object according to YANG schema for supplied path.

Parameters:

path - DOM Path

Returns:

Node with defaults set on.

getCodecRegistry

public org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry getCodecRegistry()

close

public void close()

Specified by:

close in interface AutoCloseable

getCodecFactory

public org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry getCodecFactory()

getRpcMethodToSchemaPath

public com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.SchemaPath> getRpcMethodToSchemaPath(Class<? extends org.opendaylight.yangtools.yang.binding.RpcService> key)

getRpcMethodToSchema

public com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.RpcDefinition> getRpcMethodToSchema(Class<? extends org.opendaylight.yangtools.yang.binding.RpcService> key)

create

public org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree create(org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext context)

Specified by:

create in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory

create

public org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree create(org.opendaylight.yangtools.yang.model.api.SchemaContext context,
                                                                            Class<?>... bindingClasses)

Specified by:

create in interface org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory

getSubtreeCodec

@Nonnull
public Map.Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>,org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode<?>> getSubtreeCodec(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier domIdentifier)

getNotificationClasses

public Set<Class<? extends org.opendaylight.yangtools.yang.binding.Notification>> getNotificationClasses(Set<org.opendaylight.yangtools.yang.model.api.SchemaPath> interested)