org.opendaylight.mdsal.binding.javav2.dom.adapter.impl.data.tree

Class BindingDOMDataTreeProducerAdapter

java.lang.Object

org.opendaylight.mdsal.binding.javav2.dom.adapter.impl.data.tree.BindingDOMDataTreeProducerAdapter

All Implemented Interfaces:

AutoCloseable, DataTreeProducer, DataTreeProducerFactory

@Beta
public class BindingDOMDataTreeProducerAdapter
extends Object
implements DataTreeProducer

Producer adapter.

Method Summary

Modifier and Type	Method and Description
void	close() .
static DataTreeProducer	create(DOMDataTreeProducer domProducer, BindingToNormalizedNodeCodec codec) Create instance of producer data tree.
DataTreeProducer	createProducer(Collection<DataTreeIdentifier<?>> subtrees) Create a producer, which is able to access to a set of trees.
CursorAwareWriteTransaction	createTransaction(boolean isolated) Allocate a new open transaction on this producer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static DataTreeProducer create(DOMDataTreeProducer domProducer,
                                      BindingToNormalizedNodeCodec codec)

Create instance of producer data tree.

Parameters:

domProducer - - DOM producer

codec - - codec for serialize/deserialize

Returns:

instance of producer

createTransaction

@Nonnull
public CursorAwareWriteTransaction createTransaction(boolean isolated)

Description copied from interface: DataTreeProducer

Allocate a new open transaction on this producer. Any and all transactions previously allocated must have been either submitted or cancelled by the time this method is invoked.

Specified by:

createTransaction in interface DataTreeProducer

Parameters:

isolated - Indicates whether this transaction should be a barrier. A barrier transaction is processed separately from any preceding transactions. Non-barrier transactions may be merged and processed in a batch, such that any observers see the modifications contained in them as if the modifications were made in a single transaction.

Returns:

A new CursorAwareWriteTransaction

createProducer

@Nonnull
public DataTreeProducer createProducer(@Nonnull
                                                Collection<DataTreeIdentifier<?>> subtrees)

Description copied from interface: DataTreeProducer

Create a producer, which is able to access to a set of trees..

When invoked on a DataTreeProducer, this method has additional restrictions. There may not be an open transaction from this producer. The method needs to be invoked in appropriate context, e.g. bound or unbound.

Specified subtrees must be accessible by this producer. Accessible means they are a subset of the subtrees specified when the producer is instantiated. The set is further reduced as child producers are instantiated -- if you create a producer for /a and then a child for /a/b, /a/b is not accessible from the first producer.

Once this method returns successfully, this (parent) producer loses the ability to access the specified paths until the resulting (child) producer is shut down.

Specified by:

createProducer in interface DataTreeProducer

Specified by:

createProducer in interface DataTreeProducerFactory

Parameters:

subtrees - The collection of subtrees the resulting producer should have access to.

Returns:

A DataTreeProducer instance.

close

public void close()
           throws DataTreeProducerException

Description copied from interface: DataTreeProducer

.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DataTreeProducer

Throws:

DataTreeProducerException