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

Interface BindingNormalizedNodeWriterFactory

All Superinterfaces:

BindingNormalizedNodeWriterFactory

public interface BindingNormalizedNodeWriterFactory
extends 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	newRpcWriter(Class<? extends DataContainer> rpcInputOrOutput, 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.
BindingStreamEventWriter	newWriter(InstanceIdentifier<?> 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<?> 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<?> 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.

Specified by:

newWriterAndIdentifier in interface BindingNormalizedNodeWriterFactory

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 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, RPCs).

Specified by:

newWriter in interface BindingNormalizedNodeWriterFactory

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.

Specified by:

newRpcWriter in interface BindingNormalizedNodeWriterFactory

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.

Specified by:

newNotificationWriter in interface BindingNormalizedNodeWriterFactory

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.