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

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
BindingStreamEventWriter	newNotificationWriter(Class<? extends Notification<?>> notification, 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.
BindingStreamEventWriter	newOperationWriter(Class<? extends Instantiable<?>> operationInputOrOutput, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for operation data which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
BindingStreamEventWriter	newWriter(InstanceIdentifier<? extends TreeNode> path, 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.
Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,BindingStreamEventWriter>	newWriterAndIdentifier(InstanceIdentifier<? extends TreeNode> path, 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<? extends TreeNode> 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<? extends TreeNode> 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 variation 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, operations).

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

newOperationWriter

@Nonnull
BindingStreamEventWriter newOperationWriter(@Nonnull
                                                     Class<? extends Instantiable<?>> operationInputOrOutput,
                                                     @Nonnull
                                                     org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

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

Parameters:

operationInputOrOutput - - binding class representing operation (RPC, Action) 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