org.opendaylight.mdsal.dom.spi.shard

Interface DOMDataTreeShardProducer

All Superinterfaces:

AutoCloseable, org.opendaylight.yangtools.concepts.Registration

@Beta
public interface DOMDataTreeShardProducer
extends org.opendaylight.yangtools.concepts.Registration

Method Summary

Modifier and Type	Method and Description
default void	close() Close this producer, releasing all resources.
@NonNull DOMDataTreeShardWriteTransaction	createTransaction() Create a new write transaction for this producer.
@NonNull Collection<DOMDataTreeIdentifier>	getPrefixes() Return the collection of tree identifiers to which this producer is bound.

Method Detail

getPrefixes

@NonNull Collection<DOMDataTreeIdentifier> getPrefixes()

Return the collection of tree identifiers to which this producer is bound. This collection is constant during the lifetime of a producer.

Returns:

Collection of data tree identifiers.

createTransaction

@NonNull DOMDataTreeShardWriteTransaction createTransaction()

Create a new write transaction for this producer. Any previous transactions need to be closed either via DOMDataTreeShardWriteTransaction.ready() or cancelled.

Returns:

A new write transaction

Throws:

IllegalStateException - if a previous transaction has not been closed

close

default void close()

Close this producer, releasing all resources. Default implementation does nothing, implementations should provide an implementation.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.opendaylight.yangtools.concepts.Registration