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

Interface DataObjectModification<T extends DataObject>

    • Method Detail

      • getDataType

        @NonNull Class<T> getDataType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns type of modified object.
        Returns:
        type of modified object.

      • getModificationType

        @NonNull DataObjectModification.ModificationType getModificationType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns type of modification.
        Returns:
        type Type of performed modification.

      • getDataBefore

        @Nullable T getDataBefore()
        Deprecated, for removal: This API element is subject to removal in a future version.
        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()
        Deprecated, for removal: This API element is subject to removal in a future version.
        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 DataObject>> getModifiedChildren()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns unmodifiable collection of modified direct children.
        Returns:
        unmodifiable collection of modified direct children.

      • getModifiedChildren

        default <H extends ChoiceIn<? super T> & DataObject,​C extends ChildOf<? super H>> Collection<DataObjectModification<C>> getModifiedChildren​(@NonNull Class<H> caseType,
                                                                                                                                                  @NonNull Class<C> childType)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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 ChoiceIn<? super T> & DataObject,​C extends ChildOf<? super H>> @Nullable DataObjectModification<C> getModifiedChildContainer​(@NonNull Class<H> caseType,
                                                                                                                                                      @NonNull Class<C> child)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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 ChildOf<? super T>> @Nullable DataObjectModification<C> getModifiedChildContainer​(@NonNull Class<C> child)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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 Augmentation<T> & DataObject> @Nullable DataObjectModification<C> getModifiedAugmentation​(@NonNull Class<C> augmentation)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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 Identifiable<K> & ChildOf<? super T>,​K extends Identifier<N>> DataObjectModification<N> getModifiedChildListItem​(@NonNull Class<N> listItem,
                                                                                                                                  @NonNull K listKey)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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 ChoiceIn<? super T> & DataObject,​C extends Identifiable<K> & ChildOf<? super H>,​K extends Identifier<C>> DataObjectModification<C> getModifiedChildListItem​(@NonNull Class<H> caseType,
                                                                                                                                                                                           @NonNull Class<C> listItem,
                                                                                                                                                                                           @NonNull K listKey)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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 DataObject> getModifiedChild​(InstanceIdentifier.PathArgument childArgument)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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.