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
@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.
<T extends RpcInput> T	fromNormalizedNodeActionInput(@NonNull Class<? extends Action<?,?,?>> action, @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode input) Translates supplied ContainerNode action input.
<T extends RpcOutput> T	fromNormalizedNodeActionOutput(@NonNull Class<? extends Action<?,?,?>> action, @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode output) Translates supplied ContainerNode action output.
@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.
@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.
<T extends DataObject> @Nullable InstanceIdentifier<T>	fromYangInstanceIdentifier(@NonNull org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom) Translates supplied YANG Instance Identifier into Binding instance identifier.
default @NonNull BindingLazyContainerNode<RpcInput>	toLazyNormalizedNodeActionInput(@NonNull Class<? extends Action<?,?,?>> action, @NonNull RpcInput input) Lazily translates supplied Binding action input into NormalizedNode data.
@NonNull BindingLazyContainerNode<RpcInput>	toLazyNormalizedNodeActionInput(@NonNull Class<? extends Action<?,?,?>> action, @NonNull org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier identifier, @NonNull RpcInput input) Lazily translates supplied Binding action input into NormalizedNode data.
default @NonNull BindingLazyContainerNode<RpcOutput>	toLazyNormalizedNodeActionOutput(@NonNull Class<? extends Action<?,?,?>> action, @NonNull RpcOutput output) Lazily translates supplied Binding action output into NormalizedNode data.
@NonNull BindingLazyContainerNode<RpcOutput>	toLazyNormalizedNodeActionOutput(@NonNull Class<? extends Action<?,?,?>> action, @NonNull org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier identifier, @NonNull RpcOutput output) Lazily translates supplied Binding action output into NormalizedNode data.
<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.
default @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeActionInput(@NonNull Class<? extends Action<?,?,?>> action, @NonNull RpcInput input) Translates supplied Binding action input into NormalizedNode data.
default @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeActionOutput(@NonNull Class<? extends Action<?,?,?>> action, @NonNull RpcOutput output) Translates supplied Binding action output into NormalizedNode data.
@NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeNotification(@NonNull Notification data) Translates supplied Binding Notification or output into NormalizedNode notification.
@NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeRpcData(@NonNull DataContainer data) Translates supplied Binding RPC input or output into NormalizedNode data.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifier(@NonNull 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

<T extends DataObject> @Nullable InstanceIdentifier<T> 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

fromNormalizedNodeActionInput

@Beta
<T extends RpcInput> T fromNormalizedNodeActionInput(@NonNull Class<? extends Action<?,?,?>> action,
                                                           @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode input)

Translates supplied ContainerNode action input.

Parameters:

action - Binding action class

input - ContainerNode representing data

Returns:

Binding representation of action input

Throws:

NullPointerException - if any of the arguments is null

fromNormalizedNodeActionOutput

@Beta
<T extends RpcOutput> T fromNormalizedNodeActionOutput(@NonNull Class<? extends Action<?,?,?>> action,
                                                             @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode output)

Translates supplied ContainerNode action output.

Parameters:

action - Binding action class

output - ContainerNode representing data

Returns:

Binding representation of action output

Throws:

NullPointerException - if any of the arguments is null

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

toLazyNormalizedNodeActionInput

@Beta
@NonNull BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(@NonNull Class<? extends Action<?,?,?>> action,
                                                                                  @NonNull org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier identifier,
                                                                                  @NonNull RpcInput input)

Lazily translates supplied Binding action input into NormalizedNode data.

Parameters:

action - Binding action class

input - Binding action input

Returns:

NormalizedNode representation of action input

Throws:

NullPointerException - if any of the arguments is null

toLazyNormalizedNodeActionInput

@Beta
default @NonNull BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(@NonNull Class<? extends Action<?,?,?>> action,
                                                                                          @NonNull RpcInput input)

Lazily translates supplied Binding action input into NormalizedNode data.

Parameters:

action - Binding action class

input - Binding action input

Returns:

NormalizedNode representation of action input

Throws:

NullPointerException - if any of the arguments is null

toNormalizedNodeActionInput

@Beta
default @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeActionInput(@NonNull Class<? extends Action<?,?,?>> action,
                                                                                                                 @NonNull RpcInput input)

Translates supplied Binding action input into NormalizedNode data.

Parameters:

action - Binding action class

input - Binding action input

Returns:

NormalizedNode representation of action input

Throws:

NullPointerException - if any of the arguments is null

toLazyNormalizedNodeActionOutput

@Beta
@NonNull BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(@NonNull Class<? extends Action<?,?,?>> action,
                                                                                    @NonNull org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier identifier,
                                                                                    @NonNull RpcOutput output)

Lazily translates supplied Binding action output into NormalizedNode data.

Parameters:

action - Binding action class

output - Binding action output

Returns:

NormalizedNode representation of action output

toLazyNormalizedNodeActionOutput

@Beta
default @NonNull BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(@NonNull Class<? extends Action<?,?,?>> action,
                                                                                            @NonNull RpcOutput output)

Lazily translates supplied Binding action output into NormalizedNode data.

Parameters:

action - Binding action class

output - Binding action output

Returns:

NormalizedNode representation of action output

toNormalizedNodeActionOutput

@Beta
default @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeActionOutput(@NonNull Class<? extends Action<?,?,?>> action,
                                                                                                                  @NonNull RpcOutput output)

Translates supplied Binding action output into NormalizedNode data.

Parameters:

output - Binding action output

Returns:

NormalizedNode representation of action output