org.opendaylight.mdsal.binding.api

Interface DataObjectModification<T extends DataObject>

Type Parameters:

T - Type of modified object

All Superinterfaces:

org.opendaylight.yangtools.concepts.Identifiable<InstanceIdentifier.PathArgument>

public interface DataObjectModification<T extends DataObject>
extends org.opendaylight.yangtools.concepts.Identifiable<InstanceIdentifier.PathArgument>

Modified Data Object. Represents modification of Data Object .

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataObjectModification.ModificationType Represents type of modification which has occured.

Method Summary

Methods

Modifier and Type	Method and Description
T	getDataAfter() Returns after-state of top level container.
T	getDataBefore() Returns before-state of top level container.
Class<T>	getDataType() Returns type of modified object.
InstanceIdentifier.PathArgument	getIdentifier()
DataObjectModification.ModificationType	getModificationType() Returns type of modification
<C extends Augmentation<T> & DataObject> DataObjectModification<C>	getModifiedAugmentation(Class<C> augmentation) Returns augmentation child modification if augmentation was modified by this modification.
DataObjectModification<? extends DataObject>	getModifiedChild(InstanceIdentifier.PathArgument childArgument) Returns a child modification if a node identified by childArgument was modified by this modification.
<C extends ChildOf<? super T>> DataObjectModification<C>	getModifiedChildContainer(Class<C> child) Returns container child modification if child was modified by this modification.
<C extends Identifiable<K> & ChildOf<? super T>,K extends Identifier<C>> DataObjectModification<C>	getModifiedChildListItem(Class<C> listItem, K listKey) Returns child list item modification if child was modified by this modification.
Collection<DataObjectModification<? extends DataObject>>	getModifiedChildren() Returns unmodifiable collection of modified direct children.
<C extends ChildOf<? super T>> Collection<DataObjectModification<C>>	getModifiedChildren(Class<C> childType) Returns child list item modification if child was modified by this modification.

Method Detail

getIdentifier

InstanceIdentifier.PathArgument getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<InstanceIdentifier.PathArgument>

getDataType

@Nonnull
Class<T> getDataType()

Returns type of modified object.

Returns:

type of modified object.

getModificationType

@Nonnull
DataObjectModification.ModificationType getModificationType()

Returns type of modification

Returns:

type Type of performed modification.

getDataBefore

@Nullable
T getDataBefore()

Returns before-state of top level container. Implementations are encouraged, but not required to provide this state.

Returns:

State of object before modification. Null if subtree was not present, or the implementation cannot provide the state.

getDataAfter

@Nullable
T getDataAfter()

Returns after-state of top level container.

Returns:

State of object after modification. Null if subtree is not present.

getModifiedChildren

@Nonnull
Collection<DataObjectModification<? extends DataObject>> getModifiedChildren()

Returns unmodifiable collection of modified direct children.

Returns:

unmodifiable collection of modified direct children.

getModifiedChildren

<C extends ChildOf<? super T>> Collection<DataObjectModification<C>> getModifiedChildren(@Nonnull
                                                                                       Class<C> childType)

Returns child list item modification if child was modified by this modification.

Parameters:

childType - Type of list item - must be list item with key

Returns:

Modification of child if child was modified, null otherwise.

Throws:

IllegalArgumentException - If supplied childType class is not valid child according to generated model.

getModifiedChildContainer

@Nullable
<C extends ChildOf<? super T>> DataObjectModification<C> getModifiedChildContainer(@Nonnull
                                                                                          Class<C> child)

Returns container child modification if child was modified by this modification. For accessing all modified list items consider iterating over getModifiedChildren().

Parameters:

child - Type of child - must be only container

Returns:

Modification of child if child was modified, null otherwise.

Throws:

IllegalArgumentException - If supplied child class is not valid child according to generated model.

getModifiedAugmentation

@Nullable
<C extends Augmentation<T> & DataObject> DataObjectModification<C> getModifiedAugmentation(@Nonnull
                                                                                                 Class<C> augmentation)

Returns augmentation child modification if augmentation was modified by this modification. For accessing all modified list items consider iterating over getModifiedChildren().

Parameters:

augmentation - Type of augmentation - must be only container

Returns:

Modification of augmentation if augmentation was modified, null otherwise.

Throws:

IllegalArgumentException - If supplied augmentation class is not valid augmentation according to generated model.

getModifiedChildListItem

<C extends Identifiable<K> & ChildOf<? super T>,K extends Identifier<C>> DataObjectModification<C> getModifiedChildListItem(@Nonnull
                                                                                                                         Class<C> listItem,
                                                                                                                         @Nonnull
                                                                                                                         K listKey)

Returns child list item modification if child was modified by this modification.

Parameters:

listItem - Type of list item - must be list item with key

listKey - List item key

Returns:

Modification of child if child was modified, null otherwise.

Throws:

IllegalArgumentException - If supplied listItem class is not valid child according to generated model.

getModifiedChild

@Nullable
DataObjectModification<? extends DataObject> getModifiedChild(InstanceIdentifier.PathArgument childArgument)

Returns a child modification if a node identified by childArgument was modified by this modification.

Parameters:

childArgument - Path Argument of child node

Returns:

Modification of child identified by childArgument if childArgument was modified, null otherwise.

Throws:

IllegalArgumentException - If supplied path argument is not valid child according to generated model.