org.opendaylight.controller.md.sal.binding.api

Interface DataObjectModification<T extends org.opendaylight.yangtools.yang.binding.DataObject>

All Superinterfaces:

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

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

Represents a modification of DataObject.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataObjectModification.ModificationType

Method Summary

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

Method Detail

getIdentifier

org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.yangtools.yang.binding.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

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

T getDataAfter()

Returns after-state of top level container.

Returns:

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

getModifiedChildren

@NonNull Collection<? extends DataObjectModification<? extends org.opendaylight.yangtools.yang.binding.DataObject>> getModifiedChildren()

Returns unmodifiable collection of modified direct children.

Returns:

unmodifiable collection of modified direct children.

getModifiedChildren

default <H extends org.opendaylight.yangtools.yang.binding.ChoiceIn<? super T> & org.opendaylight.yangtools.yang.binding.DataObject,C extends org.opendaylight.yangtools.yang.binding.ChildOf<? super H>> Collection<DataObjectModification<C>> getModifiedChildren(@NonNull Class<H> caseType,
                                                                                                                                                                                                                                                                    @NonNull Class<C> childType)

Returns child list item modification if child was modified by this modification. This method should be used if the child is defined in a grouping brought into a case inside this object.

Parameters:

caseType - Case type class

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

default <H extends org.opendaylight.yangtools.yang.binding.ChoiceIn<? super T> & org.opendaylight.yangtools.yang.binding.DataObject,C extends org.opendaylight.yangtools.yang.binding.ChildOf<? super H>> @Nullable DataObjectModification<C> getModifiedChildContainer(@NonNull Class<H> caseType,
                                                                                                                                                                                                                                                                        @NonNull Class<C> child)

Returns container child modification if child was modified by this modification. This method should be used if the child is defined in a grouping brought into a case inside this object.

For accessing all modified list items consider iterating over getModifiedChildren().

Parameters:

caseType - Case type class

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.

getModifiedChildContainer

<C extends org.opendaylight.yangtools.yang.binding.ChildOf<? super T>> @Nullable 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

<C extends org.opendaylight.yangtools.yang.binding.Augmentation<T> & org.opendaylight.yangtools.yang.binding.DataObject> @Nullable 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

<N extends org.opendaylight.yangtools.yang.binding.Identifiable<K> & org.opendaylight.yangtools.yang.binding.ChildOf<? super T>,K extends org.opendaylight.yangtools.yang.binding.Identifier<N>> DataObjectModification<N> getModifiedChildListItem(@NonNull Class<N> listItem,
                                                                                                                                                                                                                                                    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.

getModifiedChildListItem

default <H extends org.opendaylight.yangtools.yang.binding.ChoiceIn<? super T> & org.opendaylight.yangtools.yang.binding.DataObject,C extends org.opendaylight.yangtools.yang.binding.Identifiable<K> & org.opendaylight.yangtools.yang.binding.ChildOf<? super H>,K extends org.opendaylight.yangtools.yang.binding.Identifier<C>> DataObjectModification<C> getModifiedChildListItem(@NonNull Class<H> caseType,
                                                                                                                                                                                                                                                                                                                                                                                       @NonNull Class<C> listItem,
                                                                                                                                                                                                                                                                                                                                                                                       K listKey)

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

Parameters:

caseType - Case type class

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 org.opendaylight.yangtools.yang.binding.DataObject> getModifiedChild(org.opendaylight.yangtools.yang.binding.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.