BUG-509: add some documentation

[controller.git] / opendaylight / md-sal / sal-dom-broker / src / main / java / org / opendaylight / controller / md / sal / dom / store / impl / tree / data / AlwaysFailOperation.java

diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/tree/data/AlwaysFailOperation.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/tree/data/AlwaysFailOperation.java
index 4e3aa4911365988c916918b19a0accadf38372cd..5934fd6246c1ce6c74392d7e39b17b486d2c4309 100644 (file)
--- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/tree/data/AlwaysFailOperation.java
+++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/tree/data/AlwaysFailOperation.java
@@ -6,8 +6,13 @@ import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
 import com.google.common.base.Optional;
 import com.google.common.primitives.UnsignedLong;
 
+/**
+ * An implementation of apply operation which fails to do anything,
+ * consistently. An instance of this class is used by the data tree
+ * if it does not have a SchemaContext attached and hence cannot
+ * perform anything meaningful.
+ */
 final class AlwaysFailOperation implements ModificationApplyOperation {
-
     @Override
     public Optional<StoreMetadataNode> apply(final NodeModification modification,
             final Optional<StoreMetadataNode> storeMeta, final UnsignedLong subtreeVersion) {
@@ -25,7 +30,7 @@ final class AlwaysFailOperation implements ModificationApplyOperation {
     }
 
     @Override
-    public void verifyStructure(final NodeModification modification) throws IllegalArgumentException {
+    public void verifyStructure(final NodeModification modification) {
         throw new IllegalStateException("Schema Context is not available.");
     }
 }
\ No newline at end of file