X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-binding-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fbinding%2Fapi%2FDataObjectModification.java;h=2df4f8bde0518065a5f05eec3220cae33bbb9819;hp=f8dd3b0cceed32e7dacfdf2e37adb998ff92f087;hb=f1a918f69b787dd422a09e4e8fd83a1d52a72f83;hpb=a81d98f692b80c45bce3fe6a87e731abfb012a9f diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java index f8dd3b0cce..2df4f8bde0 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java @@ -19,28 +19,25 @@ import org.opendaylight.yangtools.yang.binding.Identifier; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument; /** - * Modified Data Object. - * - * Represents modification of Data Object. - * + * Represents a modification of DataObject. */ -public interface DataObjectModification extends org.opendaylight.yangtools.concepts.Identifiable { +public interface DataObjectModification + extends org.opendaylight.yangtools.concepts.Identifiable { enum ModificationType { /** - * * Child node (direct or indirect) was modified. * */ SUBTREE_MODIFIED, + /** - * * Node was explicitly created / overwritten. * */ + WRITE, /** - * * Node was deleted. * */ @@ -58,8 +55,7 @@ public interface DataObjectModification extends org.openda @Nonnull Class getDataType(); /** - * - * Returns type of modification + * Returns type of modification. * * @return type Type of performed modification. */ @@ -89,9 +85,9 @@ public interface DataObjectModification extends org.openda @Nonnull Collection> getModifiedChildren(); /** - * Returns container child modification if {@code child} was modified by this - * modification. + * Returns container child modification if {@code child} was modified by this modification. * + *

* For accessing all modified list items consider iterating over {@link #getModifiedChildren()}. * * @param child Type of child - must be only container @@ -99,12 +95,13 @@ public interface DataObjectModification extends org.openda * @throws IllegalArgumentException If supplied {@code child} class is not valid child according * to generated model. */ - @Nullable > DataObjectModification getModifiedChildContainer(@Nonnull Class child); + @Nullable > DataObjectModification getModifiedChildContainer( + @Nonnull Class child); /** - * Returns augmentation child modification if {@code augmentation} was modified by this - * modification. + * Returns augmentation child modification if {@code augmentation} was modified by this modification. * + *

* For accessing all modified list items consider iterating over {@link #getModifiedChildren()}. * * @param augmentation Type of augmentation - must be only container @@ -112,7 +109,8 @@ public interface DataObjectModification extends org.openda * @throws IllegalArgumentException If supplied {@code augmentation} class is not valid augmentation * according to generated model. */ - @Nullable & DataObject> DataObjectModification getModifiedAugmentation(@Nonnull Class augmentation); + @Nullable & DataObject> DataObjectModification getModifiedAugmentation( + @Nonnull Class augmentation); /** @@ -124,8 +122,8 @@ public interface DataObjectModification extends org.openda * @throws IllegalArgumentException If supplied {@code listItem} class is not valid child according * to generated model. */ - & ChildOf, K extends Identifier> DataObjectModification getModifiedChildListItem( - @Nonnull Class listItem,@Nonnull K listKey); + & ChildOf, K extends Identifier> DataObjectModification + getModifiedChildListItem(@Nonnull Class listItem,@Nonnull K listKey); /** * Returns a child modification if a node identified by {@code childArgument} was modified by @@ -139,5 +137,4 @@ public interface DataObjectModification extends org.openda * */ @Nullable DataObjectModification getModifiedChild(PathArgument childArgument); - }