X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-data-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fdata%2Fapi%2FYangInstanceIdentifier.java;h=a7539e9167f08cb0917ba2b532e12f22e925194e;hb=ce2dacd877878d47df97c524f2307f0d2b393163;hp=62c876b530495e8cdf151e4585f45a7216a4a577;hpb=2f0d8e2c8b438422d2e7a4aef04a9ae1fbd57b41;p=yangtools.git
diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java
index 62c876b530..a7539e9167 100644
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java
@@ -1,39 +1,51 @@
/*
* Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
+ *
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.yangtools.yang.data.api;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Verify.verify;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.Beta;
+import com.google.common.base.VerifyException;
+import com.google.common.cache.CacheBuilder;
+import com.google.common.cache.CacheLoader;
+import com.google.common.cache.LoadingCache;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
-import com.google.common.collect.Lists;
-import java.io.IOException;
-import java.io.ObjectInputStream;
-import java.io.ObjectOutputStream;
-import java.io.ObjectStreamException;
+import com.google.common.collect.Sets;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.Serializable;
import java.lang.reflect.Array;
-import java.lang.reflect.Field;
+import java.util.AbstractMap.SimpleImmutableEntry;
import java.util.ArrayList;
import java.util.Arrays;
-import java.util.Collections;
+import java.util.Collection;
+import java.util.Deque;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
+import java.util.Optional;
import java.util.Set;
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
+import java.util.function.Function;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.concepts.Path;
import org.opendaylight.yangtools.util.HashCodeBuilder;
+import org.opendaylight.yangtools.util.ImmutableOffsetMap;
+import org.opendaylight.yangtools.util.SingletonSet;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
@@ -42,94 +54,108 @@ import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
* Unique identifier of a particular node instance in the data tree.
*
*
- * Java representation of YANG Built-in type instance-identifier,
- * which conceptually is XPath expression minimized to uniquely identify element
- * in data tree which conforms to constraints maintained by YANG Model,
+ * Java representation of YANG Built-in type {@code instance-identifier}, which conceptually is XPath expression
+ * minimized to uniquely identify element in data tree which conforms to constraints maintained by YANG Model,
* effectively this makes Instance Identifier a path to element in data tree.
+ *
*
- * Constraints put in YANG specification on instance-identifier allowed it to be
- * effectively represented in Java and it's evaluation does not require
- * full-blown XPath processor.
- *
- *
Path Arguments
- * Path to the node represented in instance identifier consists of
- * {@link PathArgument} which carries necessary information to uniquely identify
- * node on particular level in the subtree.
- *
+ * Constraints put in YANG specification on instance-identifier allowed it to be effectively represented in Java and its
+ * evaluation does not require a full-blown XPath processor.
+ *
+ *
Path Arguments
+ * Path to the node represented in instance identifier consists of {@link PathArgument} which carries necessary
+ * information to uniquely identify node on particular level in the subtree.
+ *
*
- *
{@link NodeIdentifier} - Identifier of node, which has cardinality
- * 0..1 in particular subtree in data tree.
- *
{@link NodeIdentifierWithPredicates} - Identifier of node (list item),
- * which has cardinality 0..n.
- *
{@link NodeWithValue} - Identifier of instance leaf node or
- * leaf-list node.
- *
{@link AugmentationIdentifier} - Identifier of instance of
- * augmentation node.
+ *
{@link NodeIdentifier} - Identifier of node, which has cardinality {@code 0..1} in particular subtree in data
+ * tree
+ *
{@link NodeIdentifierWithPredicates} - Identifier of node (list item), which has cardinality {@code 0..n}
+ *
{@link NodeWithValue} - Identifier of instance {@code leaf} node or {@code leaf-list} node
+ *
{@link AugmentationIdentifier} - Identifier of instance of {@code augmentation} node
*
*
- *
* @see RFC6020
*/
-public final class YangInstanceIdentifier implements Path, Immutable, Serializable {
- @SuppressWarnings("rawtypes")
- private static final AtomicReferenceFieldUpdater LEGACYPATH_UPDATER =
- AtomicReferenceFieldUpdater.newUpdater(YangInstanceIdentifier.class, ImmutableList.class, "legacyPath");
+// FIXME: 7.0.0: this concept needs to be moved to yang-common, as parser components need the ability to refer
+// to data nodes -- most notably XPath expressions and {@code default} statement arguments need to be able
+// to represent these.
+public abstract class YangInstanceIdentifier implements Path, Immutable, Serializable {
private static final AtomicReferenceFieldUpdater TOSTRINGCACHE_UPDATER =
AtomicReferenceFieldUpdater.newUpdater(YangInstanceIdentifier.class, String.class, "toStringCache");
- private static final YangInstanceIdentifier EMPTY = trustedCreate(Collections.emptyList());
- private static final Field PATHARGUMENTS_FIELD;
+ private static final long serialVersionUID = 4L;
- private static final long serialVersionUID = 3L;
- private transient final Iterable pathArguments;
private final int hash;
-
- private volatile ImmutableList legacyPath = null;
private transient volatile String toStringCache = null;
- static {
- final Field f;
- try {
- f = YangInstanceIdentifier.class.getDeclaredField("pathArguments");
- } catch (NoSuchFieldException | SecurityException e) {
- throw new ExceptionInInitializerError(e);
- }
- f.setAccessible(true);
+ // Package-private to prevent outside subclassing
+ YangInstanceIdentifier(final int hash) {
+ this.hash = hash;
+ }
- PATHARGUMENTS_FIELD = f;
+ /**
+ * Return An empty {@link YangInstanceIdentifier}. It corresponds to the path of the conceptual root of the YANG
+ * namespace.
+ *
+ * @return An empty YangInstanceIdentifier
+ */
+ public static @NonNull YangInstanceIdentifier empty() {
+ return FixedYangInstanceIdentifier.EMPTY_INSTANCE;
}
- private final ImmutableList getLegacyPath() {
- // Temporary variable saves a volatile read
- ImmutableList ret = legacyPath;
- if (ret == null) {
- // We could have used a synchronized block, but the window is quite
- // small and worst that can happen is duplicate object construction.
- ret = ImmutableList.copyOf(pathArguments);
- LEGACYPATH_UPDATER.lazySet(this, ret);
- }
+ abstract @NonNull YangInstanceIdentifier createRelativeIdentifier(int skipFromRoot);
- return ret;
- }
+ abstract @Nullable Collection tryPathArguments();
+
+ abstract @Nullable Collection tryReversePathArguments();
/**
- * Returns a list of path arguments.
+ * Check if this instance identifier has empty path arguments, e.g. it is
+ * empty and corresponds to {@link #empty()}.
*
- * @deprecated Use {@link #getPathArguments()} instead.
- * @return Immutable list of path arguments.
+ * @return True if this instance identifier is empty, false otherwise.
*/
- @Deprecated
- public List getPath() {
- return getLegacyPath();
- }
+ public abstract boolean isEmpty();
+
+ /**
+ * Return an optimized version of this identifier, useful when the identifier
+ * will be used very frequently.
+ *
+ * @return A optimized equivalent instance.
+ */
+ public abstract @NonNull YangInstanceIdentifier toOptimized();
+
+ /**
+ * Return the conceptual parent {@link YangInstanceIdentifier}, which has
+ * one item less in {@link #getPathArguments()}.
+ *
+ * @return Parent {@link YangInstanceIdentifier}, or null if this object is {@link #empty()}.
+ */
+ public abstract @Nullable YangInstanceIdentifier getParent();
+
+ /**
+ * Return the conceptual parent {@link YangInstanceIdentifier}, which has one item less in
+ * {@link #getPathArguments()}.
+ *
+ * @return Parent {@link YangInstanceIdentifier}
+ * @throws VerifyException if this object is {@link #empty()}.
+ */
+ public abstract @NonNull YangInstanceIdentifier coerceParent();
+
+ /**
+ * Return the ancestor {@link YangInstanceIdentifier} with a particular depth, e.g. number of path arguments.
+ *
+ * @param depth Ancestor depth
+ * @return Ancestor {@link YangInstanceIdentifier}
+ * @throws IllegalArgumentException if the specified depth is negative or is greater than the depth of this object.
+ */
+ public abstract @NonNull YangInstanceIdentifier getAncestor(int depth);
/**
* Returns an ordered iteration of path arguments.
*
* @return Immutable iteration of path arguments.
*/
- public Iterable getPathArguments() {
- return pathArguments;
- }
+ public abstract @NonNull List getPathArguments();
/**
* Returns an iterable of path arguments in reverse order. This is useful
@@ -137,9 +163,7 @@ public final class YangInstanceIdentifier implements Path getReversePathArguments() {
- return getLegacyPath().reverse();
- }
+ public abstract @NonNull List getReversePathArguments();
/**
* Returns the last PathArgument. This is equivalent of iterating
@@ -147,47 +171,66 @@ public final class YangInstanceIdentifier implements Path path, final int hash) {
- this.pathArguments = Preconditions.checkNotNull(path, "path must not be null.");
- this.hash = hash;
- }
+ public static @NonNull YangInstanceIdentifier create(final Iterable path) {
+ if (Iterables.isEmpty(path)) {
+ return empty();
+ }
- private static final YangInstanceIdentifier trustedCreate(final Iterable path) {
final HashCodeBuilder hash = new HashCodeBuilder<>();
for (PathArgument a : path) {
hash.addArgument(a);
}
- return new YangInstanceIdentifier(path, hash.build());
+ return FixedYangInstanceIdentifier.create(path, hash.build());
}
- public static final YangInstanceIdentifier create(final Iterable path) {
- if (Iterables.isEmpty(path)) {
- return EMPTY;
- }
-
- return trustedCreate(ImmutableList.copyOf(path));
+ public static @NonNull YangInstanceIdentifier create(final PathArgument pathArgument) {
+ return new FixedYangInstanceIdentifier(ImmutableList.of(pathArgument),
+ HashCodeBuilder.nextHashCode(1, pathArgument));
}
- public static final YangInstanceIdentifier create(final PathArgument... path) {
+ public static @NonNull YangInstanceIdentifier create(final PathArgument... path) {
// We are forcing a copy, since we cannot trust the user
return create(Arrays.asList(path));
}
- @Override
- public int hashCode() {
- /*
- * The caching is safe, since the object contract requires
- * immutability of the object and all objects referenced from this
- * object.
- * Used lists, maps are immutable. Path Arguments (elements) are also
- * immutable, since the PathArgument contract requires immutability.
- */
- return hash;
+ /**
+ * Create a {@link YangInstanceIdentifier} by taking a snapshot of provided path and iterating it backwards.
+ *
+ * @param pathTowardsRoot Path towards root
+ * @return A {@link YangInstanceIdentifier} instance
+ * @throws NullPointerException if {@code pathTowardsRoot} or any of its members is null
+ */
+ public static @NonNull YangInstanceIdentifier createReverse(final Deque pathTowardsRoot) {
+ final ImmutableList.Builder builder = ImmutableList.builderWithExpectedSize(
+ pathTowardsRoot.size());
+ pathTowardsRoot.descendingIterator().forEachRemaining(builder::add);
+ return YangInstanceIdentifier.create(builder.build());
+ }
+
+ /**
+ * Create a {@link YangInstanceIdentifier} by walking specified stack backwards and extracting path components
+ * from it.
+ *
+ * @param stackTowardsRoot Stack towards root,
+ * @return A {@link YangInstanceIdentifier} instance
+ * @throws NullPointerException if {@code pathTowardsRoot} is null
+ */
+ public static @NonNull YangInstanceIdentifier createReverse(final Deque stackTowardsRoot,
+ final Function function) {
+ final ImmutableList.Builder builder = ImmutableList.builderWithExpectedSize(
+ stackTowardsRoot.size());
+ final Iterator it = stackTowardsRoot.descendingIterator();
+ while (it.hasNext()) {
+ builder.add(function.apply(it.next()));
+ }
+ return YangInstanceIdentifier.create(builder.build());
+ }
+
+ boolean pathArgumentsEqual(final YangInstanceIdentifier other) {
+ return Iterables.elementsEqual(getPathArguments(), other.getPathArguments());
}
@Override
@@ -195,38 +238,35 @@ public final class YangInstanceIdentifier implements Path relativeTo(final YangInstanceIdentifier ancestor) {
- final Iterator lit = pathArguments.iterator();
- final Iterator oit = ancestor.pathArguments.iterator();
+ if (this == ancestor) {
+ return Optional.of(empty());
+ }
+ if (ancestor.isEmpty()) {
+ return Optional.of(this);
+ }
+
+ final Iterator lit = getPathArguments().iterator();
+ final Iterator oit = ancestor.getPathArguments().iterator();
int common = 0;
while (oit.hasNext()) {
// Ancestor is not really an ancestor
if (!lit.hasNext() || !lit.next().equals(oit.next())) {
- return Optional.absent();
+ return Optional.empty();
}
++common;
@@ -256,17 +303,84 @@ public final class YangInstanceIdentifier implements Path lit = getPathArguments().iterator();
+ final Iterator oit = other.getPathArguments().iterator();
+
+ while (lit.hasNext()) {
+ if (!oit.hasNext()) {
+ return false;
+ }
+
+ if (!lit.next().equals(oit.next())) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ @Override
+ public final String toString() {
+ /*
+ * The toStringCache is safe, since the object contract requires
+ * immutability of the object and all objects referenced from this
+ * object.
+ * Used lists, maps are immutable. Path Arguments (elements) are also
+ * immutable, since the PathArgument contract requires immutability.
+ * The cache is thread-safe - if multiple computations occurs at the
+ * same time, cache will be overwritten with same result.
+ */
+ String ret = toStringCache;
+ if (ret == null) {
+ final StringBuilder builder = new StringBuilder("/");
+ PathArgument prev = null;
+ for (PathArgument argument : getPathArguments()) {
+ if (prev != null) {
+ builder.append('/');
+ }
+ builder.append(argument.toRelativeString(prev));
+ prev = argument;
+ }
+
+ ret = builder.toString();
+ TOSTRINGCACHE_UPDATER.lazySet(this, ret);
}
- return Optional.of(trustedCreate(Iterables.skip(pathArguments, common)));
+ return ret;
}
+ @Override
+ public final int hashCode() {
+ /*
+ * The caching is safe, since the object contract requires
+ * immutability of the object and all objects referenced from this
+ * object.
+ * Used lists, maps are immutable. Path Arguments (elements) are also
+ * immutable, since the PathArgument contract requires immutability.
+ */
+ return hash;
+ }
+
+ @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+ justification = "https://github.com/spotbugs/spotbugs/issues/811")
private static int hashCode(final Object value) {
if (value == null) {
return 0;
}
- if (value.getClass().equals(byte[].class)) {
+ if (byte[].class.equals(value.getClass())) {
return Arrays.hashCode((byte[]) value);
}
@@ -283,52 +397,56 @@ public final class YangInstanceIdentifier implements Path
* This interface itself is used as common parent for actual
* path arguments types and should not be implemented by user code.
+ *
*
* Path arguments SHOULD contain only minimum of information
* required to uniquely identify node on particular subtree level.
*
+ *
* For actual path arguments types see:
*
*
{@link NodeIdentifier} - Identifier of container or leaf
@@ -339,15 +457,12 @@ public final class YangInstanceIdentifier implements Path, Immutable, Serializable {
/**
- * If applicable returns unique QName of data node as defined in YANG
- * Schema.
- *
- * This method may return null, if the corresponding schema node, does
- * not have QName associated, such as in cases of augmentations.
+ * Returns unique QName of data node as defined in YANG Schema, if available.
*
* @return Node type
+ * @throws UnsupportedOperationException if node type is not applicable, for example in case of an augmentation.
*/
- QName getNodeType();
+ @NonNull QName getNodeType();
/**
* Return the string representation of this object for use in context
@@ -358,18 +473,16 @@ public final class YangInstanceIdentifier implements Path HASH_UPDATER =
- AtomicReferenceFieldUpdater.newUpdater(AbstractPathArgument.class, Integer.class, "hash");
+ private abstract static class AbstractPathArgument implements PathArgument {
private static final long serialVersionUID = -4546547994250849340L;
- private final QName nodeType;
- private volatile transient Integer hash = null;
+ private final @NonNull QName nodeType;
+ private transient volatile int hashValue;
protected AbstractPathArgument(final QName nodeType) {
- this.nodeType = Preconditions.checkNotNull(nodeType);
+ this.nodeType = requireNonNull(nodeType);
}
@Override
@@ -378,23 +491,19 @@ public final class YangInstanceIdentifier implements Path {
- /**
- * Adds {@link NodeIdentifier} with supplied QName to path arguments of resulting instance identifier.
- *
- * @param nodeType QName of {@link NodeIdentifier} which will be added
- * @return this builder
- */
- InstanceIdentifierBuilder node(QName nodeType);
-
- /**
- * Adds {@link NodeIdentifierWithPredicates} with supplied QName and key values to path arguments of resulting instance identifier.
- *
- * @param nodeType QName of {@link NodeIdentifierWithPredicates} which will be added
- * @param keyValues Map of key components and their respective values for {@link NodeIdentifierWithPredicates}
- * @return this builder
- */
- InstanceIdentifierBuilder nodeWithKey(QName nodeType, Map keyValues);
-
- /**
- * Adds {@link NodeIdentifierWithPredicates} with supplied QName and key, value.
- *
- * @param nodeType QName of {@link NodeIdentifierWithPredicates} which will be added
- * @param key QName of key which will be added
- * @param value value of key which will be added
- * @return this builder
- */
- InstanceIdentifierBuilder nodeWithKey(QName nodeType, QName key, Object value);
-
- /**
- *
- * Builds an {@link YangInstanceIdentifier} with path arguments from this builder
- *
- * @return {@link YangInstanceIdentifier}
- */
- @Override
- YangInstanceIdentifier build();
-
- /*
- * @deprecated use #build()
- */
- @Deprecated
- YangInstanceIdentifier toInstance();
+ abstract Object writeReplace();
}
/**
@@ -480,76 +544,292 @@ public final class YangInstanceIdentifier implements Path CACHE = CacheBuilder.newBuilder().weakValues()
+ .build(new CacheLoader() {
+ @Override
+ public NodeIdentifier load(final QName key) {
+ return new NodeIdentifier(key);
+ }
+ });
public NodeIdentifier(final QName node) {
super(node);
}
+
+ /**
+ * Return a NodeIdentifier for a particular QName. Unlike the constructor, this factory method uses a global
+ * instance cache, resulting in object reuse for equal inputs.
+ *
+ * @param node Node's QName
+ * @return A {@link NodeIdentifier}
+ */
+ public static @NonNull NodeIdentifier create(final QName node) {
+ return CACHE.getUnchecked(node);
+ }
+
+ @Override
+ Object writeReplace() {
+ return new NIv1(this);
+ }
}
/**
* Composite path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode} leaf
* overall data tree.
*/
- public static final class NodeIdentifierWithPredicates extends AbstractPathArgument {
- private static final long serialVersionUID = -4787195606494761540L;
+ public abstract static class NodeIdentifierWithPredicates extends AbstractPathArgument {
+ @Beta
+ public static final class Singleton extends NodeIdentifierWithPredicates {
+ private static final long serialVersionUID = 1L;
+
+ private final @NonNull QName key;
+ private final @NonNull Object value;
+
+ Singleton(final QName node, final QName key, final Object value) {
+ super(node);
+ this.key = requireNonNull(key);
+ this.value = requireNonNull(value);
+ }
- private final Map keyValues;
+ @Override
+ public SingletonSet> entrySet() {
+ return SingletonSet.of(singleEntry());
+ }
- public NodeIdentifierWithPredicates(final QName node, final Map keyValues) {
- super(node);
- this.keyValues = ImmutableMap.copyOf(keyValues);
- }
+ @Override
+ public SingletonSet keySet() {
+ return SingletonSet.of(key);
+ }
- public NodeIdentifierWithPredicates(final QName node, final QName key, final Object value) {
- this(node, ImmutableMap.of(key, value));
- }
+ @Override
+ public boolean containsKey(final QName qname) {
+ return key.equals(requireNonNull(qname));
+ }
- public Map getKeyValues() {
- return keyValues;
- }
+ @Override
+ public SingletonSet