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

Interface BindingNormalizedNodeWriterFactory

All Known Implementing Classes:

BindingNormalizedNodeCodecRegistry

public interface BindingNormalizedNodeWriterFactory

Factory for BindingStreamEventWriter, which provides stream writers which translates data and delegates calls to NormalizedNodeStreamWriter.

Method Summary

Modifier and Type	Method and Description
@NonNull BindingStreamEventWriter	newActionInputWriter(@NonNull Class<? extends Action<?,?,?>> action, @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for action input which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
@NonNull BindingStreamEventWriter	newActionOutputWriter(@NonNull Class<? extends Action<?,?,?>> action, @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for action output which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
@NonNull BindingStreamEventWriter	newNotificationWriter(@NonNull Class<? extends Notification> notification, @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for notification which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
@NonNull BindingStreamEventWriter	newRpcWriter(@NonNull Class<? extends DataContainer> rpcInputOrOutput, @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for RPC data which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
@NonNull BindingStreamEventWriter	newWriter(@NonNull InstanceIdentifier<?> path, @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for data tree path which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
@NonNull Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,BindingStreamEventWriter>	newWriterAndIdentifier(@NonNull InstanceIdentifier<?> path, @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for data tree path which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Method Detail

newWriterAndIdentifier

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

Creates a BindingStreamEventWriter for data tree path which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Also provides translation of supplied Instance Identifier to YangInstanceIdentifier so client code, does not need to translate that separately.

If YangInstanceIdentifier is not needed, please use newWriter(InstanceIdentifier, NormalizedNodeStreamWriter) method to conserve resources.

Parameters:

path - Binding Path in conceptual data tree, for which writer should be instantiated

domWriter - Stream writer on which events will be invoked.

Returns:

Instance Identifier and BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

Throws:

IllegalArgumentException - If supplied Instance Identifier is not valid.

newWriter

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

Creates a BindingStreamEventWriter for data tree path which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

This variant does not provide YANG instance identifier and is useful for use-cases, where InstanceIdentifier translation is done in other way, or YANG instance identifier is unnecessary (e.g. notifications, RPCs).

Parameters:

path - Binding Path in conceptual data tree, for which writer should be instantiated

domWriter - Stream writer on which events will be invoked.

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

Throws:

IllegalArgumentException - If supplied Instance Identifier is not valid.

newRpcWriter

@NonNull BindingStreamEventWriter newRpcWriter(@NonNull Class<? extends DataContainer> rpcInputOrOutput,
                                               @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Creates a BindingStreamEventWriter for RPC data which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Parameters:

rpcInputOrOutput - Binding class representing RPC input or output, for which writer should be instantiated

domWriter - Stream writer on which events will be invoked.

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

newNotificationWriter

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

Creates a BindingStreamEventWriter for notification which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Parameters:

notification - Binding class representing notification, for which writer should be instantiated

domWriter - Stream writer on which events will be invoked.

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

newActionInputWriter

@NonNull BindingStreamEventWriter newActionInputWriter(@NonNull Class<? extends Action<?,?,?>> action,
                                                       @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Creates a BindingStreamEventWriter for action input which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Parameters:

action - Binding class representing action for which writer should be instantiated

domWriter - Stream writer on which events will be invoked.

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

newActionOutputWriter

@NonNull BindingStreamEventWriter newActionOutputWriter(@NonNull Class<? extends Action<?,?,?>> action,
                                                        @NonNull org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Creates a BindingStreamEventWriter for action output which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Parameters:

action - Binding class representing action for which writer should be instantiated

domWriter - Stream writer on which events will be invoked.

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.