Fix DOMDataTreeCommitCohort
[mdsal.git] / dom / mdsal-dom-api / src / main / java / org / opendaylight / mdsal / dom / api / DOMDataTreeCommitCohort.java
index 669a0ea258cbe46525ed54f6877a9c49c2925926..cbe61124886a12cda4b506384e5042c30c7ae822 100644 (file)
@@ -7,14 +7,16 @@
  */
 package org.opendaylight.mdsal.dom.api;
 
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.annotations.Beta;
 import com.google.common.util.concurrent.FluentFuture;
 import java.util.Collection;
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.mdsal.common.api.DataValidationFailedException;
 import org.opendaylight.mdsal.common.api.PostCanCommitStep;
 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 
 /**
  * Commit cohort participating in commit of data modification, which can validate data tree
@@ -29,7 +31,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  *
  * <h2>Implementation requirements</h2>
  * <h3>Correctness assumptions</h3> Implementation SHOULD use only the {@link DOMDataTreeCandidate} instances and
- * provided {@link SchemaContext} for validation purposes.
+ * provided {@link EffectiveModelContext} for validation purposes.
  * Use of any other external mutable state is discouraged, implementation MUST NOT use any
  * transaction related APIs on same data broker / data store instance during invocation of
  * callbacks, except ones provided as argument. Note that this MAY BE enforced by some
@@ -38,7 +40,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  * and such calls may fail.
  * <h3>Correct model usage</h3> If implementation is performing YANG-model driven validation
  * implementation SHOULD use provided schema context.
- * Any other instance of {@link SchemaContext} obtained by other means, may not be valid for the
+ * Any other instance of {@link EffectiveModelContext} obtained by other means, may not be valid for the
  * associated DOMDataTreeCandidates and it may lead to incorrect validation or processing of provided
  * data.
  * <h3>DataTreeCandidate assumptions</h3> Implementation SHOULD NOT make any assumptions on a
@@ -53,7 +55,6 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  * Implementation may opt-out from receiving {@code preCommit()}, {@code commit()}, {@code abort()}
  * callbacks by returning {@link PostCanCommitStep#NOOP}.
  *
- * <p>
  * @author Tony Tkacik
  */
 // TODO: Provide example and describe more usage patterns
@@ -92,19 +93,18 @@ public interface DOMDataTreeCommitCohort {
      *         more specific subclasses of this exception to provide additional information about
      *         validation failure reason.
      */
-    @Nonnull
-    FluentFuture<PostCanCommitStep> canCommit(@Nonnull Object txId,
-            @Nonnull SchemaContext ctx, @Nonnull Collection<DOMDataTreeCandidate> candidates);
+    @NonNull FluentFuture<PostCanCommitStep> canCommit(@NonNull Object txId,
+            @NonNull EffectiveModelContext ctx, @NonNull Collection<DOMDataTreeCandidate> candidates);
 
     /**
      * An ExceptionMapper that translates an Exception to a DataValidationFailedException.
      */
     class DataValidationFailedExceptionMapper extends ExceptionMapper<DataValidationFailedException> {
-        private final DOMDataTreeIdentifier failedTreeId;
+        private final @NonNull DOMDataTreeIdentifier failedTreeId;
 
         public DataValidationFailedExceptionMapper(final String opName, final DOMDataTreeIdentifier failedTreeId) {
             super(opName, DataValidationFailedException.class);
-            this.failedTreeId = failedTreeId;
+            this.failedTreeId = requireNonNull(failedTreeId);
         }
 
         @Override