org.opendaylight.controller.md.sal.dom.store.impl

Class DOMImmutableDataChangeEvent

java.lang.Object

org.opendaylight.controller.md.sal.dom.store.impl.DOMImmutableDataChangeEvent

All Implemented Interfaces:

AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, org.opendaylight.yangtools.concepts.Immutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Immutable>

public final class DOMImmutableDataChangeEvent
extends Object
implements AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DOMImmutableDataChangeEvent.Builder
static interface	DOMImmutableDataChangeEvent.SimpleEventFactory Simple event factory which creates event based on path and data

Method Summary

Modifier and Type	Method and Description
static DOMImmutableDataChangeEvent.Builder	builder(AsyncDataBroker.DataChangeScope scope)
Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	getCreatedData() Returns a map of paths and newly created objects, which were introduced by this change into conceptual data tree, if no new objects were introduced this map will be empty.
static DOMImmutableDataChangeEvent.SimpleEventFactory	getCreateEventFactory() Event factory which takes after state and creates event for it.
Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	getOriginalData() Returns an immutable map of updated or removed paths and their original states prior to this change.
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	getOriginalSubtree() Returns an immutable stable view of data state, which captures the state of data store before the reported change.
Set<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier>	getRemovedPaths() Returns an immutable set of removed paths.
static DOMImmutableDataChangeEvent.SimpleEventFactory	getRemoveEventFactory() Event factory which takes before state and creates event for it.
protected AsyncDataBroker.DataChangeScope	getScope()
Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	getUpdatedData() Returns a map of paths and objects which were updated by this change in the conceptual data tree if no existing objects were updated this map will be empty.
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	getUpdatedSubtree() Returns an immutable stable view of data, which captures the state of data store after the reported change.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static final DOMImmutableDataChangeEvent.Builder builder(AsyncDataBroker.DataChangeScope scope)

getScope

protected AsyncDataBroker.DataChangeScope getScope()

getOriginalSubtree

public org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> getOriginalSubtree()

Description copied from interface: AsyncDataChangeEvent

Returns an immutable stable view of data state, which captures the state of data store before the reported change.

The view is rooted at the point where the listener, to which the event is being delivered, was registered.

If listener used a wildcarded path (if supported by path type) during registration for change listeners this method returns null, and original state can be accessed only via AsyncDataChangeEvent.getOriginalData()

Specified by:

getOriginalSubtree in interface AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

Stable view of data before the change happened, rooted at the listener registration path.

getUpdatedSubtree

public org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> getUpdatedSubtree()

Description copied from interface: AsyncDataChangeEvent

Returns an immutable stable view of data, which captures the state of data store after the reported change.

The view is rooted at the point where the listener, to which the event is being delivered, was registered.

If listener used a wildcarded path (if supported by path type) during registration for change listeners this method returns null, and state can be accessed only via AsyncDataChangeEvent.getCreatedData(), AsyncDataChangeEvent.getUpdatedData(), AsyncDataChangeEvent.getRemovedPaths()

Specified by:

getUpdatedSubtree in interface AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

Stable view of data after the change happened, rooted at the listener registration path.

getOriginalData

public Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> getOriginalData()

Description copied from interface: AsyncDataChangeEvent

Returns an immutable map of updated or removed paths and their original states prior to this change.

This map contains the original version of the data tree nodes (and paths to them), which are in the scope of the listener registration.

Specified by:

getOriginalData in interface AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

map of paths and original state of updated and removed objects.

getCreatedData

public Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> getCreatedData()

Description copied from interface: AsyncDataChangeEvent

Returns a map of paths and newly created objects, which were introduced by this change into conceptual data tree, if no new objects were introduced this map will be empty.

This map contains all data tree nodes (and paths to them) which were created and are in the scope of listener registration. The data tree nodes contain their whole subtree with their current state.

Specified by:

getCreatedData in interface AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

map of paths and newly created objects

getUpdatedData

public Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> getUpdatedData()

Description copied from interface: AsyncDataChangeEvent

Returns a map of paths and objects which were updated by this change in the conceptual data tree if no existing objects were updated this map will be empty.

This map contains all data tree nodes (and paths to them) which were updated and are in the scope of listener registration. The data tree nodes contain their whole subtree with their current state.

A Node is considered updated if it contents were replaced or one of its children was created, removed or updated.

Original state of the updated data tree nodes is in AsyncDataChangeEvent.getOriginalData() stored with same path.

Specified by:

getUpdatedData in interface AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

map of paths and newly created objects

getRemovedPaths

public Set<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> getRemovedPaths()

Description copied from interface: AsyncDataChangeEvent

Returns an immutable set of removed paths.

This set contains the paths to the data tree nodes which are in the scope of the listener registration that have been removed.

Original state of the removed data tree nodes is in AsyncDataChangeEvent.getOriginalData() stored with same path.

Specified by:

getRemovedPaths in interface AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

set of removed paths

toString

public String toString()

Overrides:

toString in class Object

getCreateEventFactory

public static final DOMImmutableDataChangeEvent.SimpleEventFactory getCreateEventFactory()

Event factory which takes after state and creates event for it. Factory for events based on path and after state. After state is set as getUpdatedSubtree() and is path, state mapping is also present in getUpdatedData().

Returns:

getRemoveEventFactory

public static final DOMImmutableDataChangeEvent.SimpleEventFactory getRemoveEventFactory()

Event factory which takes before state and creates event for it. Factory for events based on path and after state. After state is set as getOriginalSubtree() and is path, state mapping is also present in getOriginalSubtree(). Path is present in getRemovedPaths().

Returns: