org.opendaylight.mdsal.binding.javav2.dom.codec.api.serializer

Interface BindingNormalizedNodeSerializer

All Known Implementing Classes:

BindingNormalizedNodeCodecRegistry, BindingToNormalizedNodeCodec

public interface BindingNormalizedNodeSerializer

Serialization service, which provides two-way serialization between Java Binding Data representation and NormalizedNode representation.

Method Summary

Modifier and Type	Method and Description
Map.Entry<InstanceIdentifier<? extends TreeNode>,TreeNode>	fromNormalizedNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data) Translates supplied YANG Instance Identifier and NormalizedNode into Binding data.
Notification<?>	fromNormalizedNodeNotification(org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data) Translates supplied NormalizedNode Notification into Binding data.
TreeNode	fromNormalizedNodeOperationData(org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data) Translates supplied NormalizedNode operation (RPC, Action) input or output into Binding data.
InstanceIdentifier<? extends TreeNode>	fromYangInstanceIdentifier(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom) Translates supplied YANG Instance Identifier into Binding instance identifier.
<T extends TreeNode> Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	toNormalizedNode(InstanceIdentifier<T> path, T data) Translates supplied Binding Instance Identifier and data into NormalizedNode representation.
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeNotification(Notification<?> data) Translates supplied Binding Notification or output into NormalizedNode notification.
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeOperationData(TreeNode data) Translates supplied Binding operation (RPC, Action) input or output into NormalizedNode data.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifier(InstanceIdentifier<? extends TreeNode> binding) Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.

Method Detail

fromYangInstanceIdentifier

@Nullable
InstanceIdentifier<? extends TreeNode> fromYangInstanceIdentifier(@Nonnull
                                                                            org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom)

Translates supplied YANG Instance Identifier into Binding instance identifier.

Parameters:

dom - - YANG Instance Identifier

Returns:

Binding Instance Identifier, or null if the instance identifier is not representable

fromNormalizedNode

@Nullable
Map.Entry<InstanceIdentifier<? extends TreeNode>,TreeNode> fromNormalizedNode(@Nonnull
                                                                                        org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
                                                                                        org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

Translates supplied YANG Instance Identifier and NormalizedNode into Binding data.

Parameters:

path - - Binding Instance Identifier

data - - NormalizedNode representing data

Returns:

DOM Instance Identifier

toYangInstanceIdentifier

@Nullable
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toYangInstanceIdentifier(@Nonnull
                                                                                                   InstanceIdentifier<? extends TreeNode> 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

toNormalizedNode

@Nullable
<T extends TreeNode> Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> toNormalizedNode(InstanceIdentifier<T> path,
                                                                                                                                                                                               T data)

Translates supplied Binding Instance Identifier and data into NormalizedNode representation.

Type Parameters:

T - data type

Parameters:

path - - Binding Instance Identifier pointing to data

data - - representing Data Tree

Returns:

NormalizedNode representation

Throws:

IllegalArgumentException - - if supplied Instance Identifier is not valid.

fromNormalizedNodeNotification

@Nullable
Notification<?> fromNormalizedNodeNotification(@Nonnull
                                                         org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                         @Nonnull
                                                         org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)

Translates supplied NormalizedNode Notification into Binding data.

Parameters:

path - - Schema Path of Notification, schema path is absolute, and consists of Notification QName

data - - NormalizedNode representing data

Returns:

Binding representation of Notification

toNormalizedNodeNotification

@Nonnull
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeNotification(@Nonnull
                                                                                                    Notification<?> data)

Translates supplied Binding Notification or output into NormalizedNode notification.

Parameters:

data - NormalizedNode representing notification data

Returns:

NormalizedNode representation of notification

fromNormalizedNodeOperationData

@Nullable
TreeNode fromNormalizedNodeOperationData(@Nonnull
                                                   org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                   @Nonnull
                                                   org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)

Translates supplied NormalizedNode operation (RPC, Action) input or output into Binding data.

Parameters:

path - - schema path of operation data, schema path consists of rpc/action QName and input/output QName.

data - - NormalizedNode representing data

Returns:

Binding representation of operation data

toNormalizedNodeOperationData

@Nonnull
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeOperationData(@Nonnull
                                                                                                     TreeNode data)

Translates supplied Binding operation (RPC, Action) input or output into NormalizedNode data.

Parameters:

data - - NormalizedNode representing rpc/action data

Returns:

NormalizedNode representation of operation data