binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataObjectModification.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.mdsal.binding.api;
  10
  11 import java.util.Collection;
  12 import javax.annotation.Nonnull;
  13 import javax.annotation.Nullable;
  14 import org.opendaylight.yangtools.yang.binding.Augmentation;
  15 import org.opendaylight.yangtools.yang.binding.ChildOf;
  16 import org.opendaylight.yangtools.yang.binding.DataObject;
  17 import org.opendaylight.yangtools.yang.binding.Identifiable;
  18 import org.opendaylight.yangtools.yang.binding.Identifier;
  19 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  20
  21 /**
  22  * Modified Data Object.
  23  *
  24  * Represents modification of Data Object
  25  * .
  26  * @param <T> Type of modified object
  27  *
  28  */
  29 public interface DataObjectModification<T extends DataObject> extends org.opendaylight.yangtools.concepts.Identifiable<PathArgument> {
  30
  31     /**
  32      * Represents type of modification which has occured.
  33      *
  34      */
  35     enum ModificationType {
  36         /**
  37          *
  38          * Child node (direct or indirect) was modified.
  39          *
  40          */
  41         SUBTREE_MODIFIED,
  42         /**
  43          *
  44          * Node was explicitly created / overwritten.
  45          *
  46          */
  47         WRITE,
  48         /**
  49          *
  50          * Node was deleted.
  51          *
  52          */
  53         DELETE
  54     }
  55
  56     @Override
  57     PathArgument getIdentifier();
  58
  59     /**
  60      * Returns type of modified object.
  61      *
  62      * @return type of modified object.
  63      */
  64     @Nonnull Class<T> getDataType();
  65
  66     /**
  67      *
  68      * Returns type of modification
  69      *
  70      * @return type Type of performed modification.
  71      */
  72     @Nonnull ModificationType getModificationType();
  73
  74     /**
  75      * Returns before-state of top level container. Implementations are encouraged, but not required
  76      * to provide this state.
  77      *
  78      *
  79      * @return State of object before modification. Null if subtree was not present, or the
  80      *         implementation cannot provide the state.
  81      */
  82     @Nullable T getDataBefore();
  83
  84     /**
  85      * Returns after-state of top level container.
  86      *
  87      * @return State of object after modification. Null if subtree is not present.
  88      */
  89     @Nullable T getDataAfter();
  90
  91     /**
  92      * Returns unmodifiable collection of modified direct children.
  93      *
  94      * @return unmodifiable collection of modified direct children.
  95      */
  96     @Nonnull Collection<DataObjectModification<? extends DataObject>> getModifiedChildren();
  97
  98     /**
  99      * Returns child list item modification if {@code child} was modified by this modification.
 100      *
 101      * @param childType Type of list item - must be list item with key
 102      * @return Modification of {@code child} if {@code child} was modified, null otherwise.
 103      * @throws IllegalArgumentException If supplied {@code childType} class is not valid child according
 104      *         to generated model.
 105      */
 106     <C extends ChildOf<? super T>> Collection<DataObjectModification<C>> getModifiedChildren(@Nonnull Class<C> childType);
 107
 108     /**
 109      * Returns container child modification if {@code child} was modified by this
 110      * modification.
 111      *
 112      * For accessing all modified list items consider iterating over {@link #getModifiedChildren()}.
 113      *
 114      * @param child Type of child - must be only container
 115      * @return Modification of {@code child} if {@code child} was modified, null otherwise.
 116      * @throws IllegalArgumentException If supplied {@code child} class is not valid child according
 117      *         to generated model.
 118      */
 119     @Nullable <C extends ChildOf<? super T>> DataObjectModification<C> getModifiedChildContainer(@Nonnull Class<C> child);
 120
 121     /**
 122      * Returns augmentation child modification if {@code augmentation} was modified by this
 123      * modification.
 124      *
 125      * For accessing all modified list items consider iterating over {@link #getModifiedChildren()}.
 126      *
 127      * @param augmentation Type of augmentation - must be only container
 128      * @return Modification of {@code augmentation} if {@code augmentation} was modified, null otherwise.
 129      * @throws IllegalArgumentException If supplied {@code augmentation} class is not valid augmentation
 130      *         according to generated model.
 131      */
 132     @Nullable <C extends Augmentation<T> & DataObject> DataObjectModification<C> getModifiedAugmentation(@Nonnull Class<C> augmentation);
 133
 134
 135     /**
 136      * Returns child list item modification if {@code child} was modified by this modification.
 137      *
 138      * @param listItem Type of list item - must be list item with key
 139      * @param listKey List item key
 140      * @return Modification of {@code child} if {@code child} was modified, null otherwise.
 141      * @throws IllegalArgumentException If supplied {@code listItem} class is not valid child according
 142      *         to generated model.
 143      */
 144     <C extends Identifiable<K> & ChildOf<? super T>, K extends Identifier<C>> DataObjectModification<C> getModifiedChildListItem(
 145             @Nonnull Class<C> listItem,@Nonnull  K listKey);
 146
 147     /**
 148      * Returns a child modification if a node identified by {@code childArgument} was modified by
 149      * this modification.
 150      *
 151      * @param childArgument Path Argument of child node
 152      * @return Modification of child identified by {@code childArgument} if {@code childArgument}
 153      *         was modified, null otherwise.
 154      * @throws IllegalArgumentException If supplied path argument is not valid child according to
 155      *         generated model.
 156      *
 157      */
 158     @Nullable DataObjectModification<? extends DataObject> getModifiedChild(PathArgument childArgument);
 159
 160 }