Fix license header violations in yang-data-api
[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / YangInstanceIdentifier.java
index 79cc2c50b68228622f8bd239bb50d3f081caa90a..9c7d5c3569974f0bfd903ad93eb3573351d05557 100644 (file)
@@ -1,11 +1,13 @@
 /*
  * 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.annotations.Beta;
 import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableMap;
@@ -64,7 +66,7 @@ import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  *
  * @see <a href="http://tools.ietf.org/html/rfc6020#section-9.13">RFC6020</a>
  */
-public abstract class YangInstanceIdentifier extends IterablePathArguments implements Path<YangInstanceIdentifier>, Immutable, Serializable {
+public abstract class YangInstanceIdentifier implements Path<YangInstanceIdentifier>, Immutable, Serializable {
     /**
      * An empty {@link YangInstanceIdentifier}. It corresponds to the path of the conceptual
      * root of the YANG namespace.
@@ -96,30 +98,27 @@ public abstract class YangInstanceIdentifier extends IterablePathArguments imple
     public abstract boolean isEmpty();
 
     /**
-     * Return the conceptual parent {@link YangInstanceIdentifier}, which has
-     * one item less in {@link #getPathArguments()}.
+     * Return an optimized version of this identifier, useful when the identifier
+     * will be used very frequently.
      *
-     * @return Parent {@link YangInstanceIdentifier}, or null if this is object is {@link #EMPTY}.
+     * @return A optimized equivalent instance.
      */
-    @Nullable public abstract YangInstanceIdentifier getParent();
+    @Beta
+    public abstract YangInstanceIdentifier toOptimized();
 
     /**
-     * Returns a list of path arguments.
+     * Return the conceptual parent {@link YangInstanceIdentifier}, which has
+     * one item less in {@link #getPathArguments()}.
      *
-     * @deprecated Use {@link #getPathArguments()} instead.
-     * @return Immutable list of path arguments.
+     * @return Parent {@link YangInstanceIdentifier}, or null if this is object is {@link #EMPTY}.
      */
-    @Deprecated
-    public final List<PathArgument> getPath() {
-        return getPathArguments();
-    }
+    @Nullable public abstract YangInstanceIdentifier getParent();
 
     /**
      * Returns an ordered iteration of path arguments.
      *
      * @return Immutable iteration of path arguments.
      */
-    @Override
     public abstract List<PathArgument> getPathArguments();
 
     /**
@@ -128,7 +127,6 @@ public abstract class YangInstanceIdentifier extends IterablePathArguments imple
      *
      * @return Immutable iterable of path arguments in reverse order.
      */
-    @Override
     public abstract List<PathArgument> getReversePathArguments();
 
     /**
@@ -243,12 +241,61 @@ public abstract class YangInstanceIdentifier extends IterablePathArguments imple
         return Optional.of(createRelativeIdentifier(common));
     }
 
+    @Override
+    public final boolean contains(final YangInstanceIdentifier other) {
+        Preconditions.checkArgument(other != null, "other should not be null");
+
+        final Iterator<?> 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 ret;
+    }
+
     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);
         }
 
@@ -268,7 +315,6 @@ public abstract class YangInstanceIdentifier extends IterablePathArguments imple
     // Static factories & helpers
 
     /**
-     *
      * Returns a new InstanceIdentifier with only one path argument of type {@link NodeIdentifier} with supplied QName
      *
      * @param name QName of first node identifier
@@ -279,7 +325,6 @@ public abstract class YangInstanceIdentifier extends IterablePathArguments imple
     }
 
     /**
-     *
      * Returns new builder for InstanceIdentifier with empty path arguments.
      *
      * @return new builder for InstanceIdentifier with empty path arguments.
@@ -292,7 +337,7 @@ public abstract class YangInstanceIdentifier extends IterablePathArguments imple
      *
      * Returns new builder for InstanceIdentifier with path arguments copied from original instance identifier.
      *
-     * @param origin Instace Identifier from which path arguments are copied.
+     * @param origin InstanceIdentifier from which path arguments are copied.
      * @return new builder for InstanceIdentifier with path arguments copied from original instance identifier.
      */
     public static InstanceIdentifierBuilder builder(final YangInstanceIdentifier origin) {
@@ -515,6 +560,11 @@ public abstract class YangInstanceIdentifier extends IterablePathArguments imple
             }
 
             final Map<QName, Object> otherKeyValues = ((NodeIdentifierWithPredicates) obj).keyValues;
+
+            // TODO: benchmark to see if just calling equals() on the two maps is not faster
+            if (keyValues == otherKeyValues) {
+                return true;
+            }
             if (keyValues.size() != otherKeyValues.size()) {
                 return false;
             }
@@ -687,53 +737,4 @@ public abstract class YangInstanceIdentifier extends IterablePathArguments imple
             }
         }
     }
-
-    @Override
-    public final boolean contains(final YangInstanceIdentifier other) {
-        Preconditions.checkArgument(other != null, "other should not be null");
-
-        final Iterator<?> 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 ret;
-    }
 }