*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;
+import com.google.common.base.MoreObjects;
+import com.google.common.base.MoreObjects.ToStringHelper;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.Collection;
import java.util.Map;
import java.util.Optional;
import java.util.function.Predicate;
-import javax.annotation.Nonnull;
-import javax.annotation.concurrent.NotThreadSafe;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.schema.DistinctNodeContainer;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
* reconstruct the effective data node presentation, it is sufficient to perform a depth-first pre-order traversal of
* the tree.
*/
-@NotThreadSafe
final class ModifiedNode extends NodeModification implements StoreTreeNode<ModifiedNode> {
static final Predicate<ModifiedNode> IS_TERMINAL_PREDICATE = input -> {
requireNonNull(input);
};
private final Map<PathArgument, ModifiedNode> children;
- private final Optional<TreeNode> original;
+ private final Optional<? extends TreeNode> original;
private final PathArgument identifier;
private LogicalOperation operation = LogicalOperation.NONE;
private Optional<TreeNode> snapshotCache;
- private NormalizedNode<?, ?> value;
+ private NormalizedNode value;
private ModificationType modType;
// Alternative history introduced in WRITE nodes. Instantiated when we touch any child underneath such a node.
private TreeNode writtenOriginal;
// Internal cache for TreeNodes created as part of validation
- private SchemaAwareApplyOperation validatedOp;
- private Optional<TreeNode> validatedCurrent;
- private TreeNode validatedNode;
+ private ModificationApplyOperation validatedOp;
+ private Optional<? extends TreeNode> validatedCurrent;
+ private Optional<? extends TreeNode> validatedNode;
- private ModifiedNode(final PathArgument identifier, final Optional<TreeNode> original,
+ private ModifiedNode(final PathArgument identifier, final Optional<? extends TreeNode> original,
final ChildTrackingPolicy childPolicy) {
this.identifier = identifier;
this.original = original;
}
@Override
- Optional<TreeNode> getOriginal() {
+ Optional<? extends TreeNode> getOriginal() {
return original;
}
*
* @return Currently-written value
*/
- NormalizedNode<?, ?> getWrittenValue() {
- return value;
+ @NonNull NormalizedNode getWrittenValue() {
+ return verifyNotNull(value);
}
/**
* @return Child modification if direct child or it's subtree was modified.
*/
@Override
- public Optional<ModifiedNode> getChild(final PathArgument child) {
- return Optional.ofNullable(children.get(child));
+ public ModifiedNode childByArg(final PathArgument arg) {
+ return children.get(arg);
}
- private Optional<TreeNode> metadataFromSnapshot(@Nonnull final PathArgument child) {
- return original.isPresent() ? original.get().getChild(child) : Optional.empty();
+ private Optional<? extends TreeNode> metadataFromSnapshot(final @NonNull PathArgument child) {
+ return original.isPresent() ? original.get().findChildByArg(child) : Optional.empty();
}
- private Optional<TreeNode> metadataFromData(@Nonnull final PathArgument child, final Version modVersion) {
+ private Optional<? extends TreeNode> metadataFromData(final @NonNull PathArgument child, final Version modVersion) {
if (writtenOriginal == null) {
// Lazy instantiation, as we do not want do this for all writes. We are using the modification's version
// here, as that version is what the SchemaAwareApplyOperation will see when dealing with the resulting
writtenOriginal = TreeNodeFactory.createTreeNode(value, modVersion);
}
- return writtenOriginal.getChild(child);
+ return writtenOriginal.findChildByArg(child);
}
/**
* @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
* @return Before-image tree node as observed by that child.
*/
- private Optional<TreeNode> findOriginalMetadata(@Nonnull final PathArgument child, final Version modVersion) {
+ private Optional<? extends TreeNode> findOriginalMetadata(final @NonNull PathArgument child,
+ final Version modVersion) {
switch (operation) {
case DELETE:
// DELETE implies non-presence
* @return {@link ModifiedNode} for specified child, with {@link #getOriginal()}
* containing child metadata if child was present in original data.
*/
- ModifiedNode modifyChild(@Nonnull final PathArgument child, @Nonnull final ModificationApplyOperation childOper,
- @Nonnull final Version modVersion) {
+ ModifiedNode modifyChild(final @NonNull PathArgument child, final @NonNull ModificationApplyOperation childOper,
+ final @NonNull Version modVersion) {
clearSnapshot();
if (operation == LogicalOperation.NONE) {
updateOperationType(LogicalOperation.TOUCH);
return potential;
}
- final Optional<TreeNode> currentMetadata = findOriginalMetadata(child, modVersion);
-
-
+ final Optional<? extends TreeNode> currentMetadata = findOriginalMetadata(child, modVersion);
final ModifiedNode newlyCreated = new ModifiedNode(child, currentMetadata, childOper.getChildPolicy());
if (operation == LogicalOperation.MERGE && value != null) {
/*
* value contains this component, we need to materialize it as a MERGE modification.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
- final Optional<NormalizedNode<?, ?>> childData = ((NormalizedNodeContainer)value).getChild(child);
- if (childData.isPresent()) {
- childOper.mergeIntoModifiedNode(newlyCreated, childData.get(), modVersion);
+ final NormalizedNode childData = ((DistinctNodeContainer)value).childByArg(child);
+ if (childData != null) {
+ childOper.mergeIntoModifiedNode(newlyCreated, childData, modVersion);
}
}
/**
* Records a write for associated node.
*
- * @param value new value
+ * @param newValue new value
*/
- void write(final NormalizedNode<?, ?> value) {
- updateValue(LogicalOperation.WRITE, value);
+ void write(final NormalizedNode newValue) {
+ updateValue(LogicalOperation.WRITE, newValue);
children.clear();
}
case WRITE:
// A WRITE can collapse all of its children
if (!children.isEmpty()) {
- value = schema.apply(this, getOriginal(), version).get().getData();
+ value = schema.apply(this, getOriginal(), version).map(TreeNode::getData).orElse(null);
children.clear();
}
- schema.verifyStructure(value, true);
+ if (value == null) {
+ // The write has ended up being empty, such as a write of an empty list.
+ updateOperationType(LogicalOperation.DELETE);
+ } else {
+ schema.fullVerifyStructure(value);
+ }
break;
default:
break;
@Override
public String toString() {
- return "NodeModification [identifier=" + identifier + ", modificationType="
- + operation + ", childModification=" + children + "]";
+ final ToStringHelper helper = MoreObjects.toStringHelper(this).omitNullValues()
+ .add("identifier", identifier).add("operation", operation).add("modificationType", modType);
+ if (!children.isEmpty()) {
+ helper.add("childModification", children);
+ }
+ return helper.toString();
}
- void resolveModificationType(@Nonnull final ModificationType type) {
+ void resolveModificationType(final @NonNull ModificationType type) {
modType = type;
}
* Update this node's value and operation type without disturbing any of its child modifications.
*
* @param type New operation type
- * @param value New node value
+ * @param newValue New node value
*/
- void updateValue(final LogicalOperation type, final NormalizedNode<?, ?> value) {
- this.value = requireNonNull(value);
+ void updateValue(final LogicalOperation type, final NormalizedNode newValue) {
+ this.value = requireNonNull(newValue);
updateOperationType(type);
}
return new ModifiedNode(metadataTree.getIdentifier(), Optional.of(metadataTree), childPolicy);
}
- void setValidatedNode(final SchemaAwareApplyOperation op, final Optional<TreeNode> current, final TreeNode node) {
+ void setValidatedNode(final ModificationApplyOperation op, final Optional<? extends TreeNode> current,
+ final Optional<? extends TreeNode> node) {
this.validatedOp = requireNonNull(op);
this.validatedCurrent = requireNonNull(current);
this.validatedNode = requireNonNull(node);
}
- TreeNode getValidatedNode(final SchemaAwareApplyOperation op, final Optional<TreeNode> current) {
+ /**
+ * Acquire pre-validated node assuming a previous operation and node. This is a counterpart to
+ * {@link #setValidatedNode(ModificationApplyOperation, Optional, Optional)}.
+ *
+ * @param op Currently-executing operation
+ * @param current Currently-used tree node
+ * @return {@code null} if there is a mismatch with previously-validated node (if present) or the result of previous
+ * validation.
+ */
+ @SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL",
+ justification = "The contract is package-internal and well documented, we do not need a separate wrapper")
+ @Nullable Optional<? extends TreeNode> getValidatedNode(final ModificationApplyOperation op,
+ final Optional<? extends TreeNode> current) {
return op.equals(validatedOp) && current.equals(validatedCurrent) ? validatedNode : null;
}
}