* Propagate @Nonnull and @Nullable declarations.
* Suppress unused warnings for AbstractCursor's closed field.
* Remove redundant generic type declarations.
* In AbstractDataTreeCandidateNode, make sure that either newData or
oldData is not null (or both).
* Remove CaseEnforcer::enforceOnTreeNode() which is unused.
* Remove unnecessary semi-colons in MandatoryLeafEnforcer.
* Remove MinMaxElementsValidation::checkOriginalPresent() which is
unused.
* SchemaAwareApplyOperation::checkConflicting indicates its result
using an exception, so drop the return value which is always true
(this method isn't used anywhere else in Boron).
* SchemaAwareApplyOperation::checkNotConflicting is static, so its
final modifier is redundant.
Change-Id: I7f1ebe53753edd0b0ec5c333ac0cc2850c959f15
Signed-off-by: Stephen Kitt <skitt@redhat.com>
import com.google.common.base.Preconditions;
import java.util.Arrays;
import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshotCursor;
AtomicIntegerFieldUpdater.newUpdater(AbstractCursor.class, "closed");
private final YangInstanceIdentifier rootPath;
private final T parent;
+ // closed isn't unused, it's updated by CLOSED_UPDATER but data-flow analysers can't see that
+ @SuppressWarnings("unused")
private volatile int closed;
AbstractCursor(final T parent, final YangInstanceIdentifier rootPath) {
}
@Override
- public final void enter(final PathArgument... path) {
+ public final void enter(@Nonnull final PathArgument... path) {
enter(Arrays.asList(path));
}
import com.google.common.cache.LoadingCache;
import com.google.common.util.concurrent.UncheckedExecutionException;
import java.util.concurrent.ExecutionException;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
private final LoadingCache<PathArgument, ModificationApplyOperation> childCache = CacheBuilder.newBuilder()
.build(new CacheLoader<PathArgument, ModificationApplyOperation>() {
@Override
- public ModificationApplyOperation load(final PathArgument key) {
+ public ModificationApplyOperation load(@Nonnull final PathArgument key) {
if (key instanceof AugmentationIdentifier && schema instanceof AugmentationTarget) {
return SchemaAwareApplyOperation.from(schema, (AugmentationTarget) schema, (AugmentationIdentifier) key, treeType);
}
@Override
public final Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
try {
- return Optional.<ModificationApplyOperation> fromNullable(childCache.get(identifier));
+ return Optional.fromNullable(childCache.get(identifier));
} catch (ExecutionException | UncheckedExecutionException e) {
LOG.trace("Child {} not present in container schema {} children {}", identifier, this, schema.getChildNodes(), e.getCause());
return Optional.absent();
import com.google.common.collect.Collections2;
import java.util.ArrayList;
import java.util.Collection;
+import java.util.Collections;
+import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
static Collection<DataTreeCandidateNode> deltaChildren(@Nullable final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> oldData,
@Nullable final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> newData) {
+ Preconditions.checkArgument(newData != null || oldData != null,
+ "No old or new data, modification type should be NONE and deltaChildren() mustn't be called.");
if (newData == null) {
return Collections2.transform(oldData.getValue(), TO_DELETED_NODE);
}
}
@Override
+ @Nonnull
public final PathArgument getIdentifier() {
return data.getIdentifier();
}
}
final Optional<TreeNode> newRoot = m.getStrategy().apply(m.getRootModification(),
- Optional.<TreeNode>of(currentRoot), m.getVersion());
+ Optional.of(currentRoot), m.getVersion());
Preconditions.checkState(newRoot.isPresent(), "Apply strategy failed to produce root node for modification %s", modification);
return new InMemoryDataTreeCandidate(PUBLIC_ROOT_PATH, root, currentRoot, newRoot.get());
}
import com.google.common.base.Preconditions;
import java.util.Collection;
import java.util.Collections;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
}
@Override
+ @Nonnull
public final PathArgument getIdentifier() {
return data.getIdentifier();
}
import com.google.common.collect.Collections2;
import java.util.Collection;
import java.util.Collections;
+import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
}
@Override
+ @Nonnull
public Collection<DataTreeCandidateNode> getChildNodes() {
switch (mod.getModificationType()) {
case APPEARED:
}
@Override
+ @Nonnull
public ModificationType getModificationType() {
return Verify.verifyNotNull(mod.getModificationType(), "Node %s does not have resolved modification type", mod);
}
}
@Override
+ @Nonnull
public final Optional<NormalizedNode<?, ?>> getDataAfter() {
return optionalData(newMeta);
}
@Override
+ @Nonnull
public final Optional<NormalizedNode<?, ?>> getDataBefore() {
return optionalData(oldMeta);
}
}
@Override
+ @Nonnull
public PathArgument getIdentifier() {
return getMod().getIdentifier();
}
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
}
@Override
+ @Nonnull
public final ModificationType getModificationType() {
return ModificationType.WRITE;
}
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
return children.keySet();
}
- void enforceOnTreeNode(final TreeNode tree) {
- enforcer.enforceOnTreeNode(tree);
- }
-
void enforceOnTreeNode(final NormalizedNode<?, ?> normalizedNode) {
enforcer.enforceOnTreeNode(normalizedNode);
}
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import com.google.common.base.Optional;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
}
@Override
+ @Nonnull
public ModificationType getModificationType() {
return ModificationType.DELETE;
}
@Override
+ @Nonnull
public Optional<NormalizedNode<?, ?>> getDataAfter() {
return Optional.absent();
}
@Override
+ @Nonnull
public Optional<NormalizedNode<?, ?>> getDataBefore() {
return dataOptional();
}
import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
}
@Override
+ @Nonnull
protected TreeNode getTipRoot() {
return state.getRoot();
}
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
}
@Override
+ @Nonnull
public PathArgument getIdentifier() {
throw new IllegalStateException("Attempted to get identifier of the root node");
}
}
@Override
+ @Nonnull
protected TreeNode getTipRoot() {
return root.getNewMeta();
}
import java.util.Collection;
import java.util.Map.Entry;
import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
}
@Override
- public void applyToCursor(final DataTreeModificationCursor cursor) {
+ public void applyToCursor(@Nonnull final DataTreeModificationCursor cursor) {
for (final ModifiedNode child : rootNode.getChildren()) {
applyNode(cursor, child);
}
}
@Override
- public DataTreeModificationCursor createCursor(final YangInstanceIdentifier path) {
+ public DataTreeModificationCursor createCursor(@Nonnull final YangInstanceIdentifier path) {
final OperationWithModification op = resolveModificationFor(path);
return openCursor(new InMemoryDataTreeModificationCursor(this, path, op));
}
import java.util.Collection;
import java.util.Deque;
import java.util.Iterator;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
}
@Override
- public void enter(final PathArgument child) {
+ public void enter(@Nonnull final PathArgument child) {
stack.push(resolveChildModification(child));
}
@Override
- public void enter(final Iterable<PathArgument> path) {
+ public void enter(
@Nonnull final Iterable<PathArgument> path) {
int depth = 0;
for (PathArgument child : path) {
try {
}
@Override
- public Optional<NormalizedNode<?, ?>> readNode(final PathArgument child) {
+ public Optional<NormalizedNode<?, ?>> readNode(@Nonnull final PathArgument child) {
return stack.peek().read(child, getParent().getVersion());
}
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
}
@Override
- public DataTreeSnapshotCursor createCursor(final YangInstanceIdentifier path) {
+ public DataTreeSnapshotCursor createCursor(@Nonnull final YangInstanceIdentifier path) {
final Optional<NormalizedNode<?, ?>> maybeRoot = NormalizedNodes.findNode(rootNode.getData(), path);
if (!maybeRoot.isPresent()) {
return null;
import com.google.common.base.Preconditions;
import java.util.ArrayDeque;
import java.util.Deque;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
}
@Override
- public void enter(final PathArgument child) {
+ public void enter(@Nonnull final PathArgument child) {
final Optional<NormalizedNode<?, ?>> maybeChildNode = NormalizedNodes.getDirectChild(stack.peek(), child);
Preconditions.checkArgument(maybeChildNode.isPresent(), "Child %s not found", child);
}
@Override
- public void enter(final Iterable<PathArgument> path) {
+ public void enter(
@Nonnull final Iterable<PathArgument> path) {
final Optional<NormalizedNode<?, ?>> maybeChildNode = NormalizedNodes.findNode(stack.peek(), path);
Preconditions.checkArgument(maybeChildNode.isPresent(), "Child %s not found", path);
}
@Override
- public Optional<NormalizedNode<?, ?>> readNode(final PathArgument child) {
+ public Optional<NormalizedNode<?, ?>> readNode(@Nonnull final PathArgument child) {
return NormalizedNodes.findNode(stack.peek(), child);
}
}
protected void enforceOnTreeNode(final NormalizedNode<?, ?> normalizedNode) {
// Intentional no-op
}
- };
+ }
+
private static final class Strict extends MandatoryLeafEnforcer {
private final Collection<YangInstanceIdentifier> mandatoryNodes;
data.getIdentifier(), id);
}
}
- };
+ }
private static final Logger LOG = LoggerFactory.getLogger(MandatoryLeafEnforcer.class);
private static final MandatoryLeafEnforcer NOOP_ENFORCER = new NoOp();
value.getClass()));
}
- private static boolean checkOriginalPresent(ModifiedNode child) {
- return child.getOriginal().isPresent();
- }
-
@Override
protected void checkTouchApplicable(final YangInstanceIdentifier path, final NodeModification modification,
final Optional<TreeNode> current, final Version version) throws DataValidationFailedException {
* Implementations MUST expose all nested suboperations which operates on child
* nodes expose via {@link #getChild(PathArgument)} method.
* <li>Same suboperations SHOULD be used when invoked via
- * {@link #apply(ModifiedNode, Optional)} if applicable.
+ * {@link #apply(ModifiedNode, Optional, Version)} if applicable.
*
*
* Hierarchical composite operation which is responsible for applying
* @throws IllegalArgumentException
* If it is not possible to apply Operation on provided Metadata
* node
- * @return new {@link StoreMetadataNode} if operation resulted in updating
+ * @return new {@link TreeNode} if operation resulted in updating
* node, {@link Optional#absent()} if {@link ModifiedNode}
* resulted in deletion of this node.
*/
abstract Optional<TreeNode> apply(ModifiedNode modification, Optional<TreeNode> storeMeta, Version version);
/**
- *
* Checks if provided node modification could be applied to current metadata node.
*
* @param modification Modification
* @param current Metadata Node to which modification should be applied
* @param version
- * @return true if modification is applicable
- * false if modification is no applicable
- * @throws DataValidationFailedException
+ * @throws DataValidationFailedException if the modification is not applicable
*/
abstract void checkApplicable(YangInstanceIdentifier path, NodeModification modification, Optional<TreeNode> current, Version version) throws DataValidationFailedException;
import java.util.Collection;
import java.util.Map;
import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
* Node Modification Node and Tree
*
* Tree which structurally resembles data tree and captures client modifications to the data store tree. This tree is
- * lazily created and populated via {@link #modifyChild(PathArgument)} and {@link TreeNode} which represents original
- * state as tracked by {@link #getOriginal()}.
+ * lazily created and populated via {@link #modifyChild(PathArgument, ModificationApplyOperation, Version)} and
+ * {@link TreeNode} which represents original state as tracked by {@link #getOriginal()}.
*
* The contract is that the state information exposed here preserves the temporal ordering of whatever modifications
* were executed. A child's effects pertain to data node as modified by its ancestors. This means that in order to
final class ModifiedNode extends NodeModification implements StoreTreeNode<ModifiedNode> {
static final Predicate<ModifiedNode> IS_TERMINAL_PREDICATE = new Predicate<ModifiedNode>() {
@Override
- public boolean apply(@Nonnull final ModifiedNode input) {
+ public boolean apply(@Nullable final ModifiedNode input) {
Preconditions.checkNotNull(input);
switch (input.getOperation()) {
case DELETE:
*/
@Override
public Optional<ModifiedNode> getChild(final PathArgument child) {
- return Optional.<ModifiedNode> fromNullable(children.get(child));
+ return Optional.fromNullable(children.get(child));
}
private Optional<TreeNode> metadataFromSnapshot(@Nonnull final PathArgument child) {
import com.google.common.base.Preconditions;
import java.util.Collection;
import java.util.Collections;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
final class NoopDataTreeCandidate extends AbstractDataTreeCandidate {
private static final DataTreeCandidateNode ROOT = new DataTreeCandidateNode() {
@Override
+ @Nonnull
public ModificationType getModificationType() {
return ModificationType.UNMODIFIED;
}
}
@Override
+ @Nonnull
public PathArgument getIdentifier() {
throw new IllegalStateException("Attempted to read identifier of the no-operation change");
}
@Override
+ @Nonnull
public Optional<NormalizedNode<?, ?>> getDataAfter() {
return Optional.absent();
}
@Override
+ @Nonnull
public Optional<NormalizedNode<?, ?>> getDataBefore() {
return Optional.absent();
}
}
@Override
+ @Nonnull
protected TreeNode getTipRoot() {
return afterRoot;
}
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import com.google.common.base.Optional;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
}
@Override
+ @Nonnull
public ModificationType getModificationType() {
return ModificationType.DELETE;
}
}
@Override
+ @Nonnull
public Optional<NormalizedNode<?, ?>> getDataAfter() {
return Optional.absent();
}
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import java.util.Collection;
+import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
}
@Override
+ @Nonnull
public ModificationType getModificationType() {
return ModificationType.WRITE;
}
}
@Override
+ @Nonnull
public Collection<DataTreeCandidateNode> getChildNodes() {
return deltaChildren(oldData, getData());
}
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import com.google.common.base.Optional;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
}
@Override
+ @Nonnull
public ModificationType getModificationType() {
return ModificationType.UNMODIFIED;
}
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import com.google.common.base.Optional;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
}
@Override
+ @Nonnull
public ModificationType getModificationType() {
return ModificationType.WRITE;
}
}
@Override
+ @Nonnull
public Optional<NormalizedNode<?, ?>> getDataBefore() {
return Optional.absent();
}
return null;
}
- public static boolean checkConflicting(final YangInstanceIdentifier path, final boolean condition, final String message) throws ConflictingModificationAppliedException {
- if(!condition) {
+ public static void checkConflicting(final YangInstanceIdentifier path, final boolean condition,
+ final String message) throws ConflictingModificationAppliedException {
+ if (!condition) {
throw new ConflictingModificationAppliedException(path, message);
}
- return condition;
}
private static SchemaAwareApplyOperation fromListSchemaNode(final ListSchemaNode schemaNode, final TreeType treeType) {
return MinMaxElementsValidation.from(op, schemaNode);
}
- protected static final void checkNotConflicting(final YangInstanceIdentifier path, final TreeNode original, final TreeNode current) throws ConflictingModificationAppliedException {
+ protected static void checkNotConflicting(final YangInstanceIdentifier path, final TreeNode original, final TreeNode current) throws ConflictingModificationAppliedException {
checkConflicting(path, original.getVersion().equals(current.getVersion()),
"Node was replaced by other transaction.");
checkConflicting(path, original.getSubtreeVersion().equals(current.getSubtreeVersion()),
* @param modification Node modification which should be applied.
* @param current Current state of data tree
* @throws ConflictingModificationAppliedException If subtree was changed in conflicting way
- * @throws IncorrectDataStructureException If subtree modification is not applicable (e.g. leaf node).
+ * @throws org.opendaylight.yangtools.yang.data.api.schema.tree.IncorrectDataStructureException If subtree
+ * modification is not applicable (e.g. leaf node).
*/
protected abstract void checkTouchApplicable(YangInstanceIdentifier path, NodeModification modification,
Optional<TreeNode> current, Version version) throws DataValidationFailedException;
*
* @param treeType Tree Type
* @param node Schema node
- * @return
+ * @return {@code true} if the node matches the tree type, {@code false} otherwise.
*/
static boolean belongsToTree(final TreeType treeType, final DataSchemaNode node) {
return treeType == TreeType.OPERATIONAL || node.isConfiguration();
*/
final class StructuralContainerModificationStrategy extends ModificationApplyOperation {
/**
- * Fake TreeNode version used in {@link #checkApplicable(YangInstanceIdentifier, NodeModification, Optional)}.
+ * Fake TreeNode version used in
+ * {@link #checkApplicable(YangInstanceIdentifier, NodeModification, Optional, Version)}.
* It is okay to use a global constant, as the delegate will ignore it anyway. For
* {@link #apply(ModifiedNode, Optional, Version)} we will use the appropriate version as provided to us.
*/
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import com.google.common.base.Optional;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
}
@Override
+ @Nonnull
public ModificationType getModificationType() {
return ModificationType.UNMODIFIED;
}
*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import javax.annotation.Nonnull;
import com.google.common.base.Optional;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
}
@Override
+ @Nonnull
public Optional<NormalizedNode<?, ?>> getDataBefore() {
return Optional.absent();
}
Code Review / yangtools.git / commitdiff