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

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<?>,DataObject>	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.
DataObject	fromNormalizedNodeRpcData(org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data) Translates supplied NormalizedNode RPC input or output into Binding data.
InstanceIdentifier<?>	fromYangInstanceIdentifier(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom) Translates supplied YANG Instance Identifier into Binding instance identifier.
<T extends DataObject> 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	toNormalizedNodeRpcData(DataContainer data) Translates supplied Binding RPC input or output into NormalizedNode data.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifier(InstanceIdentifier<?> binding) Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.

Method Detail

toYangInstanceIdentifier

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

fromYangInstanceIdentifier

@Nullable
InstanceIdentifier<?> 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.

toNormalizedNode

<T extends DataObject> 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.

Parameters:

path - Binding Instance Identifier pointing to data

data - Data object representing data

Returns:

NormalizedNode representation

Throws:

IllegalArgumentException - If supplied Instance Identifier is not valid.

fromNormalizedNode

@Nullable
Map.Entry<InstanceIdentifier<?>,DataObject> 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

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

fromNormalizedNodeRpcData

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

Translates supplied NormalizedNode RPC input or output into Binding data.

Parameters:

path - Schema path of RPC data, Schema path consists of rpc QName and input / output QName.

data - NormalizedNode representing data

Returns:

Binding representation of RPC data

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

toNormalizedNodeRpcData

@Nonnull
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeRpcData(@Nonnull
                                                                                               DataContainer data)

Translates supplied Binding RPC input or output into NormalizedNode data.

Parameters:

data - NormalizedNode representing rpc data

Returns:

NormalizedNode representation of rpc data