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=a582e5c32a3e1f0855bfbaad0a9685172ff42464;hb=0d55e5ea183d9fc7ff8e7acc72e9172e90836662;hp=60432b512faff22c47d38167c471a22ed17bbf14;hpb=06452ecebb1998538c59a0a5ed47f47034045af5;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 60432b512f..a582e5c32a 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
@@ -8,37 +8,36 @@ package org.opendaylight.yangtools.yang.data.api;
 
 import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
-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.Serializable;
 import java.lang.reflect.Array;
-import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Collections;
+import java.util.Collection;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Objects;
 import java.util.Set;
-
+import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
+import javax.annotation.Nonnull;
+import javax.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.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
 
 /**
- * Unique identifier of a partical node instance in the data tree.
+ * Unique identifier of a particular node instance in the data tree.
  *
  * <p>
  * Java representation of YANG Built-in type <code>instance-identifier</code>,
- * which conceptually is XPath expression minimised to uniquely identify element
+ * 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.
  * <p>
@@ -63,29 +62,46 @@ import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  * </ul>
  *
  *
- * @see http://tools.ietf.org/html/rfc6020#section-9.13
+ * @see <a href="http://tools.ietf.org/html/rfc6020#section-9.13">RFC6020</a>
  */
-public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier>, Immutable, Serializable {
-    private static final YangInstanceIdentifier EMPTY = trustedCreate(Collections.<PathArgument>emptyList());
+public abstract class YangInstanceIdentifier extends IterablePathArguments implements Path<YangInstanceIdentifier>, Immutable, Serializable {
+    /**
+     * An empty {@link YangInstanceIdentifier}. It corresponds to the path of the conceptual
+     * root of the YANG namespace.
+     */
+    public static final YangInstanceIdentifier EMPTY = FixedYangInstanceIdentifier.EMPTY_INSTANCE;
+
+    private static final AtomicReferenceFieldUpdater<YangInstanceIdentifier, String> TOSTRINGCACHE_UPDATER =
+            AtomicReferenceFieldUpdater.newUpdater(YangInstanceIdentifier.class, String.class, "toStringCache");
+    private static final long serialVersionUID = 4L;
 
-    private static final long serialVersionUID = 2L;
-    private final Iterable<PathArgument> pathArguments;
     private final int hash;
+    private transient volatile String toStringCache = null;
 
-    private transient ImmutableList<PathArgument> legacyPath = null;
-    private transient String toStringCache = null;
+    // Package-private to prevent outside subclassing
+    YangInstanceIdentifier(final int hash) {
+        this.hash = hash;
+    }
 
-    private final ImmutableList<PathArgument> getLegacyPath() {
-        if (legacyPath == null) {
-            synchronized (this) {
-                if (legacyPath == null) {
-                    legacyPath = ImmutableList.copyOf(pathArguments);
-                }
-            }
-        }
+    @Nonnull abstract YangInstanceIdentifier createRelativeIdentifier(int skipFromRoot);
+    @Nonnull abstract Collection<PathArgument> tryPathArguments();
+    @Nonnull abstract Collection<PathArgument> tryReversePathArguments();
 
-        return legacyPath;
-    }
+    /**
+     * Check if this instance identifier has empty path arguments, e.g. it is
+     * empty and corresponds to {@link #EMPTY}.
+     *
+     * @return True if this instance identifier is empty, false otherwise.
+     */
+    public abstract boolean isEmpty();
+
+    /**
+     * Return the conceptual parent {@link YangInstanceIdentifier}, which has
+     * one item less in {@link #getPathArguments()}.
+     *
+     * @return Parent {@link YangInstanceIdentifier}, or null if this is object is {@link #EMPTY}.
+     */
+    @Nullable public abstract YangInstanceIdentifier getParent();
 
     /**
      * Returns a list of path arguments.
@@ -94,18 +110,15 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      * @return Immutable list of path arguments.
      */
     @Deprecated
-    public List<PathArgument> getPath() {
-        return getLegacyPath();
-    }
+    public abstract List<PathArgument> getPath();
 
     /**
      * Returns an ordered iteration of path arguments.
      *
      * @return Immutable iteration of path arguments.
      */
-    public Iterable<PathArgument> getPathArguments() {
-        return pathArguments;
-    }
+    @Override
+    public abstract Collection<PathArgument> getPathArguments();
 
     /**
      * Returns an iterable of path arguments in reverse order. This is useful
@@ -113,9 +126,8 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      *
      * @return Immutable iterable of path arguments in reverse order.
      */
-    public Iterable<PathArgument> getReversePathArguments() {
-        return getLegacyPath().reverse();
-    }
+    @Override
+    public abstract Collection<PathArgument> getReversePathArguments();
 
     /**
      * Returns the last PathArgument. This is equivalent of iterating
@@ -123,39 +135,28 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      *
      * @return The last past argument, or null if there are no PathArguments.
      */
-    public PathArgument getLastPathArgument() {
-        return Iterables.getFirst(getReversePathArguments(), null);
-    }
+    public abstract PathArgument getLastPathArgument();
 
-    private YangInstanceIdentifier(final Iterable<PathArgument> path, final int hash) {
-        this.pathArguments = Preconditions.checkNotNull(path, "path must not be null.");
-        this.hash = hash;
-    }
+    public static YangInstanceIdentifier create(final Iterable<? extends PathArgument> path) {
+        if (Iterables.isEmpty(path)) {
+            return EMPTY;
+        }
 
-    private static final YangInstanceIdentifier trustedCreate(final Iterable<PathArgument> path) {
         final HashCodeBuilder<PathArgument> hash = new HashCodeBuilder<>();
         for (PathArgument a : path) {
             hash.addArgument(a);
         }
 
-        return new YangInstanceIdentifier(path, hash.toInstance());
-    }
-
-    public static final YangInstanceIdentifier create(final Iterable<? extends PathArgument> path) {
-        if (Iterables.isEmpty(path)) {
-            return EMPTY;
-        }
-
-        return trustedCreate(ImmutableList.copyOf(path));
+        return FixedYangInstanceIdentifier.create(path, hash.build());
     }
 
-    public static final YangInstanceIdentifier create(final PathArgument... path) {
+    public static 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() {
+    public final int hashCode() {
         /*
          * The caching is safe, since the object contract requires
          * immutability of the object and all objects referenced from this
@@ -166,22 +167,24 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         return hash;
     }
 
+    boolean pathArgumentsEqual(final YangInstanceIdentifier other) {
+        return Iterables.elementsEqual(getPathArguments(), other.getPathArguments());
+    }
+
     @Override
     public boolean equals(final Object obj) {
         if (this == obj) {
             return true;
         }
-        if (obj == null) {
-            return false;
-        }
-        if (getClass() != obj.getClass()) {
+        if (!(obj instanceof YangInstanceIdentifier)) {
             return false;
         }
         YangInstanceIdentifier other = (YangInstanceIdentifier) obj;
         if (this.hashCode() != obj.hashCode()) {
             return false;
         }
-        return Iterables.elementsEqual(pathArguments, other.pathArguments);
+
+        return pathArgumentsEqual(other);
     }
 
     /**
@@ -190,7 +193,7 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      * @param name QName of {@link NodeIdentifier}
      * @return Instance Identifier with additional path argument added to the end.
      */
-    public YangInstanceIdentifier node(final QName name) {
+    public final YangInstanceIdentifier node(final QName name) {
         return node(new NodeIdentifier(name));
     }
 
@@ -201,8 +204,8 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      * @param arg Path argument which should be added to the end
      * @return Instance Identifier with additional path argument added to the end.
      */
-    public YangInstanceIdentifier node(final PathArgument arg) {
-        return new YangInstanceIdentifier(Iterables.concat(pathArguments, Collections.singleton(arg)), HashCodeBuilder.nextHashCode(hash, arg));
+    public final YangInstanceIdentifier node(final PathArgument arg) {
+        return new StackedYangInstanceIdentifier(this, arg, HashCodeBuilder.nextHashCode(hash, arg));
     }
 
     /**
@@ -215,8 +218,8 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      *         the specified parent is not in fact an ancestor of this object.
      */
     public Optional<YangInstanceIdentifier> relativeTo(final YangInstanceIdentifier ancestor) {
-        final Iterator<?> lit = pathArguments.iterator();
-        final Iterator<?> oit = ancestor.pathArguments.iterator();
+        final Iterator<?> lit = getPathArguments().iterator();
+        final Iterator<?> oit = ancestor.getPathArguments().iterator();
         int common = 0;
 
         while (oit.hasNext()) {
@@ -234,7 +237,8 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         if (!lit.hasNext()) {
             return Optional.of(EMPTY);
         }
-        return Optional.of(trustedCreate(Iterables.skip(pathArguments, common)));
+
+        return Optional.of(createRelativeIdentifier(common));
     }
 
     private static int hashCode(final Object value) {
@@ -278,8 +282,8 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      *
      * @return new builder for InstanceIdentifier with empty path arguments.
      */
-    static public InstanceIdentifierBuilder builder() {
-        return new BuilderImpl();
+    public static InstanceIdentifierBuilder builder() {
+        return new YangInstanceIdentifierBuilder();
     }
 
     /**
@@ -289,27 +293,14 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      * @param origin Instace Identifier from which path arguments are copied.
      * @return new builder for InstanceIdentifier with path arguments copied from original instance identifier.
      */
-    static public InstanceIdentifierBuilder builder(final YangInstanceIdentifier origin) {
-        return new BuilderImpl(origin.getPathArguments(), origin.hashCode());
-    }
-
-    /**
-     * Returns new builder for InstanceIdentifier with first path argument set to {@link NodeIdentifier}.
-     *
-     * @param node QName of first {@link NodeIdentifier} path argument.
-     * @return  new builder for InstanceIdentifier with first path argument set to {@link NodeIdentifier}.
-     *
-     * @deprecated Either use {@link #node(QName)} or instantiate an intermediate builder.
-     */
-    @Deprecated
-    public static InstanceIdentifierBuilder builder(final QName node) {
-        return builder().node(node);
+    public static InstanceIdentifierBuilder builder(final YangInstanceIdentifier origin) {
+        return new YangInstanceIdentifierBuilder(origin.getPathArguments(), origin.hashCode());
     }
 
     /**
      * Path argument / component of InstanceIdentifier
      *
-     * Path argument uniquelly identifies node in data tree on particular
+     * Path argument uniquely identifies node in data tree on particular
      * level.
      * <p>
      * This interface itself is used as common parent for actual
@@ -337,11 +328,24 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
          * @return Node type
          */
         QName getNodeType();
+
+        /**
+         * Return the string representation of this object for use in context
+         * provided by a previous object. This method can be implemented in
+         * terms of {@link #toString()}, but implementations are encourage to
+         * reuse any context already emitted by the previous object.
+         *
+         * @param previous Previous path argument
+         * @return String representation
+         */
+        String toRelativeString(PathArgument previous);
     }
 
     private static abstract class AbstractPathArgument implements PathArgument {
         private static final long serialVersionUID = -4546547994250849340L;
         private final QName nodeType;
+        private transient int hashValue;
+        private volatile transient boolean hashGuard = false;
 
         protected AbstractPathArgument(final QName nodeType) {
             this.nodeType = Preconditions.checkNotNull(nodeType);
@@ -357,11 +361,20 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
             return nodeType.compareTo(o.getNodeType());
         }
 
-        @Override
-        public int hashCode() {
+        protected int hashCodeImpl() {
             return 31 + getNodeType().hashCode();
         }
 
+        @Override
+        public final int hashCode() {
+            if (!hashGuard) {
+                hashValue = hashCodeImpl();
+                hashGuard = true;
+            }
+
+            return hashValue;
+        }
+
         @Override
         public boolean equals(final Object obj) {
             if (this == obj) {
@@ -378,14 +391,22 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         public String toString() {
             return getNodeType().toString();
         }
+
+        @Override
+        public String toRelativeString(final PathArgument previous) {
+            if (previous instanceof AbstractPathArgument) {
+                final QNameModule mod = ((AbstractPathArgument)previous).getNodeType().getModule();
+                if (getNodeType().getModule().equals(mod)) {
+                    return getNodeType().getLocalName();
+                }
+            }
+
+            return getNodeType().toString();
+        }
     }
 
     /**
-     *
      * Fluent Builder of Instance Identifier instances
-     *
-     * @
-     *
      */
     public interface InstanceIdentifierBuilder extends Builder<YangInstanceIdentifier> {
         /**
@@ -421,7 +442,14 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
          *
          * @return {@link YangInstanceIdentifier}
          */
+        @Override
         YangInstanceIdentifier build();
+
+        /*
+         * @deprecated use #build()
+         */
+        @Deprecated
+        YangInstanceIdentifier toInstance();
     }
 
     /**
@@ -459,9 +487,9 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         }
 
         @Override
-        public int hashCode() {
+        protected int hashCodeImpl() {
             final int prime = 31;
-            int result = super.hashCode();
+            int result = super.hashCodeImpl();
             result = prime * result;
 
             for (Entry<QName, Object> entry : keyValues.entrySet()) {
@@ -496,6 +524,11 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         public String toString() {
             return super.toString() + '[' + keyValues + ']';
         }
+
+        @Override
+        public String toRelativeString(final PathArgument previous) {
+            return super.toRelativeString(previous) + '[' + keyValues + ']';
+        }
     }
 
     /**
@@ -517,9 +550,9 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         }
 
         @Override
-        public int hashCode() {
+        protected int hashCodeImpl() {
             final int prime = 31;
-            int result = super.hashCode();
+            int result = super.hashCodeImpl();
             result = prime * result + ((value == null) ? 0 : YangInstanceIdentifier.hashCode(value));
             return result;
         }
@@ -537,6 +570,11 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         public String toString() {
             return super.toString() + '[' + value + ']';
         }
+
+        @Override
+        public String toRelativeString(final PathArgument previous) {
+            return super.toRelativeString(previous) + '[' + value + ']';
+        }
     }
 
     /**
@@ -551,7 +589,7 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
      * / module to the target node.
      *
      *
-     * @see http://tools.ietf.org/html/rfc6020#section-7.15
+     * @see <a href="http://tools.ietf.org/html/rfc6020#section-7.15">RFC6020</a>
      */
     public static final class AugmentationIdentifier implements PathArgument {
         private static final long serialVersionUID = -8122335594681936939L;
@@ -576,19 +614,6 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         }
 
         /**
-         * Augmentation node has no QName
-         *
-         * @deprecated Use
-         *             {@link AugmentationIdentifier#AugmentationIdentifier(Set)}
-         *             instead.
-         */
-        @Deprecated
-        public AugmentationIdentifier(final QName nodeType, final Set<QName> childNames) {
-            this(childNames);
-        }
-
-        /**
-         *
          * Returns set of all possible child nodes
          *
          * @return set of all possible child nodes.
@@ -599,11 +624,16 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
 
         @Override
         public String toString() {
-            final StringBuffer sb = new StringBuffer("AugmentationIdentifier{");
+            final StringBuilder sb = new StringBuilder("AugmentationIdentifier{");
             sb.append("childNames=").append(childNames).append('}');
             return sb.toString();
         }
 
+        @Override
+        public String toRelativeString(final PathArgument previous) {
+            return toString();
+        }
+
         @Override
         public boolean equals(final Object o) {
             if (this == o) {
@@ -648,62 +678,12 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
         }
     }
 
-    private static class BuilderImpl implements InstanceIdentifierBuilder {
-        private final HashCodeBuilder<PathArgument> hash;
-        private final List<PathArgument> path;
-
-        public BuilderImpl() {
-            this.hash = new HashCodeBuilder<>();
-            this.path = new ArrayList<>();
-        }
-
-        public BuilderImpl(final Iterable<PathArgument> prefix, final int hash) {
-            this.path = Lists.newArrayList(prefix);
-            this.hash = new HashCodeBuilder<>(hash);
-        }
-
-        @Override
-        public InstanceIdentifierBuilder node(final QName nodeType) {
-            final PathArgument arg = new NodeIdentifier(nodeType);
-            path.add(arg);
-            hash.addArgument(arg);
-            return this;
-        }
-
-        @Override
-        public InstanceIdentifierBuilder nodeWithKey(final QName nodeType, final QName key, final Object value) {
-            final PathArgument arg = new NodeIdentifierWithPredicates(nodeType, key, value);
-            path.add(arg);
-            hash.addArgument(arg);
-            return this;
-        }
-
-        @Override
-        public InstanceIdentifierBuilder nodeWithKey(final QName nodeType, final Map<QName, Object> keyValues) {
-            final PathArgument arg = new NodeIdentifierWithPredicates(nodeType, keyValues);
-            path.add(arg);
-            hash.addArgument(arg);
-            return this;
-        }
-
-        @Override
-        @Deprecated
-        public YangInstanceIdentifier toInstance() {
-            return build();
-        }
-
-        @Override
-        public YangInstanceIdentifier build() {
-            return new YangInstanceIdentifier(ImmutableList.copyOf(path), hash.toInstance());
-        }
-    }
-
     @Override
-    public boolean contains(final YangInstanceIdentifier other) {
+    public final boolean contains(final YangInstanceIdentifier other) {
         Preconditions.checkArgument(other != null, "other should not be null");
 
-        final Iterator<?> lit = pathArguments.iterator();
-        final Iterator<?> oit = other.pathArguments.iterator();
+        final Iterator<?> lit = getPathArguments().iterator();
+        final Iterator<?> oit = other.getPathArguments().iterator();
 
         while (lit.hasNext()) {
             if (!oit.hasNext()) {
@@ -719,7 +699,7 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
         /*
          * The toStringCache is safe, since the object contract requires
          * immutability of the object and all objects referenced from this
@@ -729,22 +709,21 @@ public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier
          * The cache is thread-safe - if multiple computations occurs at the
          * same time, cache will be overwritten with same result.
          */
-        if (toStringCache != null) {
-            return toStringCache;
-        }
-
-        final StringBuilder builder = new StringBuilder('/');
-        boolean first = true;
-        for (PathArgument argument : getPathArguments()) {
-            if (first) {
-                first = false;
-            } else {
-                builder.append('/');
+        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;
             }
-            builder.append(argument.toString());
-        }
 
-        toStringCache = builder.toString();
-        return toStringCache;
+            ret = builder.toString();
+            TOSTRINGCACHE_UPDATER.lazySet(this, ret);
+        }
+        return ret;
     }
 }