yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
   3  * This program and the accompanying materials are made available under the
   4  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   5  * and is available at http://www.eclipse.org/legal/epl-v10.html
   6  */
   7 package org.opendaylight.yangtools.yang.data.api;
   8
   9 import com.google.common.base.Optional;
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.ImmutableList;
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.ImmutableSet;
  14 import com.google.common.collect.Iterables;
  15 import com.google.common.collect.Lists;
  16 import java.io.IOException;
  17 import java.io.ObjectInputStream;
  18 import java.io.ObjectOutputStream;
  19 import java.io.Serializable;
  20 import java.lang.reflect.Array;
  21 import java.lang.reflect.Field;
  22 import java.util.ArrayList;
  23 import java.util.Arrays;
  24 import java.util.Collections;
  25 import java.util.Iterator;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Map.Entry;
  29 import java.util.Objects;
  30 import java.util.Set;
  31 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
  32 import org.opendaylight.yangtools.concepts.Builder;
  33 import org.opendaylight.yangtools.concepts.Immutable;
  34 import org.opendaylight.yangtools.concepts.Path;
  35 import org.opendaylight.yangtools.util.HashCodeBuilder;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.opendaylight.yangtools.yang.common.QNameModule;
  38 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  39
  40 /**
  41  * Unique identifier of a particular node instance in the data tree.
  42  *
  43  * <p>
  44  * Java representation of YANG Built-in type <code>instance-identifier</code>,
  45  * which conceptually is XPath expression minimized to uniquely identify element
  46  * in data tree which conforms to constraints maintained by YANG Model,
  47  * effectively this makes Instance Identifier a path to element in data tree.
  48  * <p>
  49  * Constraints put in YANG specification on instance-identifier allowed it to be
  50  * effectively represented in Java and it's evaluation does not require
  51  * full-blown XPath processor.
  52  * <p>
  53  * <h3>Path Arguments</h3>
  54  * Path to the node represented in instance identifier consists of
  55  * {@link PathArgument} which carries necessary information to uniquely identify
  56  * node on particular level in the subtree.
  57  * <p>
  58  * <ul>
  59  * <li>{@link NodeIdentifier} - Identifier of node, which has cardinality
  60  * <code>0..1</code> in particular subtree in data tree.</li>
  61  * <li>{@link NodeIdentifierWithPredicates} - Identifier of node (list item),
  62  * which has cardinality <code>0..n</code>.</li>
  63  * <li>{@link NodeWithValue} - Identifier of instance <code>leaf</code> node or
  64  * <code>leaf-list</code> node.</li>
  65  * <li>{@link AugmentationIdentifier} - Identifier of instance of
  66  * <code>augmentation</code> node.</li>
  67  * </ul>
  68  *
  69  *
  70  * @see <a href="http://tools.ietf.org/html/rfc6020#section-9.13">RFC6020</a>
  71  */
  72 public final class YangInstanceIdentifier implements Path<YangInstanceIdentifier>, Immutable, Serializable {
  73     @SuppressWarnings("rawtypes")
  74     private static final AtomicReferenceFieldUpdater<YangInstanceIdentifier, ImmutableList> LEGACYPATH_UPDATER =
  75             AtomicReferenceFieldUpdater.newUpdater(YangInstanceIdentifier.class, ImmutableList.class, "legacyPath");
  76     private static final AtomicReferenceFieldUpdater<YangInstanceIdentifier, String> TOSTRINGCACHE_UPDATER =
  77             AtomicReferenceFieldUpdater.newUpdater(YangInstanceIdentifier.class, String.class, "toStringCache");
  78     private static final YangInstanceIdentifier EMPTY = trustedCreate(Collections.<PathArgument>emptyList());
  79     private static final Field PATHARGUMENTS_FIELD;
  80
  81     private static final long serialVersionUID = 3L;
  82     private transient final Iterable<PathArgument> pathArguments;
  83     private final int hash;
  84
  85     private volatile ImmutableList<PathArgument> legacyPath = null;
  86     private transient volatile String toStringCache = null;
  87
  88     static {
  89         final Field f;
  90         try {
  91             f = YangInstanceIdentifier.class.getDeclaredField("pathArguments");
  92         } catch (NoSuchFieldException | SecurityException e) {
  93             throw new ExceptionInInitializerError(e);
  94         }
  95         f.setAccessible(true);
  96
  97         PATHARGUMENTS_FIELD = f;
  98     }
  99
 100     private final ImmutableList<PathArgument> getLegacyPath() {
 101         // Temporary variable saves a volatile read
 102         ImmutableList<PathArgument> ret = legacyPath;
 103         if (ret == null) {
 104             // We could have used a synchronized block, but the window is quite
 105             // small and worst that can happen is duplicate object construction.
 106             ret = ImmutableList.copyOf(pathArguments);
 107             LEGACYPATH_UPDATER.lazySet(this, ret);
 108         }
 109
 110         return ret;
 111     }
 112
 113     /**
 114      * Returns a list of path arguments.
 115      *
 116      * @deprecated Use {@link #getPathArguments()} instead.
 117      * @return Immutable list of path arguments.
 118      */
 119     @Deprecated
 120     public List<PathArgument> getPath() {
 121         return getLegacyPath();
 122     }
 123
 124     /**
 125      * Returns an ordered iteration of path arguments.
 126      *
 127      * @return Immutable iteration of path arguments.
 128      */
 129     public Iterable<PathArgument> getPathArguments() {
 130         return pathArguments;
 131     }
 132
 133     /**
 134      * Returns an iterable of path arguments in reverse order. This is useful
 135      * when walking up a tree organized this way.
 136      *
 137      * @return Immutable iterable of path arguments in reverse order.
 138      */
 139     public Iterable<PathArgument> getReversePathArguments() {
 140         return getLegacyPath().reverse();
 141     }
 142
 143     /**
 144      * Returns the last PathArgument. This is equivalent of iterating
 145      * to the last element of the iterable returned by {@link #getPathArguments()}.
 146      *
 147      * @return The last past argument, or null if there are no PathArguments.
 148      */
 149     public PathArgument getLastPathArgument() {
 150         return Iterables.getFirst(getReversePathArguments(), null);
 151     }
 152
 153     private YangInstanceIdentifier(final Iterable<PathArgument> path, final int hash) {
 154         this.pathArguments = Preconditions.checkNotNull(path, "path must not be null.");
 155         this.hash = hash;
 156     }
 157
 158     private static final YangInstanceIdentifier trustedCreate(final Iterable<PathArgument> path) {
 159         final HashCodeBuilder<PathArgument> hash = new HashCodeBuilder<>();
 160         for (PathArgument a : path) {
 161             hash.addArgument(a);
 162         }
 163
 164         return new YangInstanceIdentifier(path, hash.toInstance());
 165     }
 166
 167     public static final YangInstanceIdentifier create(final Iterable<? extends PathArgument> path) {
 168         if (Iterables.isEmpty(path)) {
 169             return EMPTY;
 170         }
 171
 172         return trustedCreate(ImmutableList.copyOf(path));
 173     }
 174
 175     public static final YangInstanceIdentifier create(final PathArgument... path) {
 176         // We are forcing a copy, since we cannot trust the user
 177         return create(Arrays.asList(path));
 178     }
 179
 180     @Override
 181     public int hashCode() {
 182         /*
 183          * The caching is safe, since the object contract requires
 184          * immutability of the object and all objects referenced from this
 185          * object.
 186          * Used lists, maps are immutable. Path Arguments (elements) are also
 187          * immutable, since the PathArgument contract requires immutability.
 188          */
 189         return hash;
 190     }
 191
 192     @Override
 193     public boolean equals(final Object obj) {
 194         if (this == obj) {
 195             return true;
 196         }
 197         if (obj == null) {
 198             return false;
 199         }
 200         if (getClass() != obj.getClass()) {
 201             return false;
 202         }
 203         YangInstanceIdentifier other = (YangInstanceIdentifier) obj;
 204         if (this.hashCode() != obj.hashCode()) {
 205             return false;
 206         }
 207         return Iterables.elementsEqual(pathArguments, other.pathArguments);
 208     }
 209
 210     /**
 211      * Constructs a new Instance Identifier with new {@link NodeIdentifier} added to the end of path arguments
 212      *
 213      * @param name QName of {@link NodeIdentifier}
 214      * @return Instance Identifier with additional path argument added to the end.
 215      */
 216     public YangInstanceIdentifier node(final QName name) {
 217         return node(new NodeIdentifier(name));
 218     }
 219
 220     /**
 221      *
 222      * Constructs a new Instance Identifier with new {@link PathArgument} added to the end of path arguments
 223      *
 224      * @param arg Path argument which should be added to the end
 225      * @return Instance Identifier with additional path argument added to the end.
 226      */
 227     public YangInstanceIdentifier node(final PathArgument arg) {
 228         return new YangInstanceIdentifier(Iterables.concat(pathArguments, Collections.singleton(arg)), HashCodeBuilder.nextHashCode(hash, arg));
 229     }
 230
 231     /**
 232      * Get the relative path from an ancestor. This method attempts to perform
 233      * the reverse of concatenating a base (ancestor) and a path.
 234      *
 235      * @param ancestor
 236      *            Ancestor against which the relative path should be calculated
 237      * @return This object's relative path from parent, or Optional.absent() if
 238      *         the specified parent is not in fact an ancestor of this object.
 239      */
 240     public Optional<YangInstanceIdentifier> relativeTo(final YangInstanceIdentifier ancestor) {
 241         final Iterator<?> lit = pathArguments.iterator();
 242         final Iterator<?> oit = ancestor.pathArguments.iterator();
 243         int common = 0;
 244
 245         while (oit.hasNext()) {
 246             // Ancestor is not really an ancestor
 247             if (!lit.hasNext() || !lit.next().equals(oit.next())) {
 248                 return Optional.absent();
 249             }
 250
 251             ++common;
 252         }
 253
 254         if (common == 0) {
 255             return Optional.of(this);
 256         }
 257         if (!lit.hasNext()) {
 258             return Optional.of(EMPTY);
 259         }
 260         return Optional.of(trustedCreate(Iterables.skip(pathArguments, common)));
 261     }
 262
 263     private static int hashCode(final Object value) {
 264         if (value == null) {
 265             return 0;
 266         }
 267
 268         if (value.getClass().equals(byte[].class)) {
 269             return Arrays.hashCode((byte[]) value);
 270         }
 271
 272         if (value.getClass().isArray()) {
 273             int hash = 0;
 274             int length = Array.getLength(value);
 275             for (int i = 0; i < length; i++) {
 276                 hash += Objects.hashCode(Array.get(value, i));
 277             }
 278
 279             return hash;
 280         }
 281
 282         return Objects.hashCode(value);
 283     }
 284
 285     // Static factories & helpers
 286
 287     /**
 288      *
 289      * Returns a new InstanceIdentifier with only one path argument of type {@link NodeIdentifier} with supplied QName
 290      *
 291      * @param name QName of first node identifier
 292      * @return Instance Identifier with only one path argument of type {@link NodeIdentifier}
 293      */
 294     public static YangInstanceIdentifier of(final QName name) {
 295         return create(new NodeIdentifier(name));
 296     }
 297
 298     /**
 299      *
 300      * Returns new builder for InstanceIdentifier with empty path arguments.
 301      *
 302      * @return new builder for InstanceIdentifier with empty path arguments.
 303      */
 304     static public InstanceIdentifierBuilder builder() {
 305         return new BuilderImpl();
 306     }
 307
 308     /**
 309      *
 310      * Returns new builder for InstanceIdentifier with path arguments copied from original instance identifier.
 311      *
 312      * @param origin Instace Identifier from which path arguments are copied.
 313      * @return new builder for InstanceIdentifier with path arguments copied from original instance identifier.
 314      */
 315     static public InstanceIdentifierBuilder builder(final YangInstanceIdentifier origin) {
 316         return new BuilderImpl(origin.getPathArguments(), origin.hashCode());
 317     }
 318
 319     /**
 320      * Returns new builder for InstanceIdentifier with first path argument set to {@link NodeIdentifier}.
 321      *
 322      * @param node QName of first {@link NodeIdentifier} path argument.
 323      * @return  new builder for InstanceIdentifier with first path argument set to {@link NodeIdentifier}.
 324      *
 325      * @deprecated Either use {@link #node(QName)} or instantiate an intermediate builder.
 326      */
 327     @Deprecated
 328     public static InstanceIdentifierBuilder builder(final QName node) {
 329         return builder().node(node);
 330     }
 331
 332     /**
 333      * Path argument / component of InstanceIdentifier
 334      *
 335      * Path argument uniquely identifies node in data tree on particular
 336      * level.
 337      * <p>
 338      * This interface itself is used as common parent for actual
 339      * path arguments types and should not be implemented by user code.
 340      * <p>
 341      * Path arguments SHOULD contain only minimum of information
 342      * required to uniquely identify node on particular subtree level.
 343      *
 344      * For actual path arguments types see:
 345      * <ul>
 346      * <li>{@link NodeIdentifier} - Identifier of container or leaf
 347      * <li>{@link NodeIdentifierWithPredicates} - Identifier of list entries, which have key defined
 348      * <li>{@link AugmentationIdentifier} - Identifier of augmentation
 349      * <li>{@link NodeWithValue} - Identifier of leaf-list entry
 350      * </ul>
 351      */
 352     public interface PathArgument extends Comparable<PathArgument>, Immutable, Serializable {
 353         /**
 354          * If applicable returns unique QName of data node as defined in YANG
 355          * Schema.
 356          *
 357          * This method may return null, if the corresponding schema node, does
 358          * not have QName associated, such as in cases of augmentations.
 359          *
 360          * @return Node type
 361          */
 362         QName getNodeType();
 363
 364         /**
 365          * Return the string representation of this object for use in context
 366          * provided by a previous object. This method can be implemented in
 367          * terms of {@link #toString()}, but implementations are encourage to
 368          * reuse any context already emitted by the previous object.
 369          *
 370          * @param previous Previous path argument
 371          * @return String representation
 372          */
 373         String toRelativeString(PathArgument previous);
 374     }
 375
 376     private static abstract class AbstractPathArgument implements PathArgument {
 377         private static final AtomicReferenceFieldUpdater<AbstractPathArgument, Integer> HASH_UPDATER =
 378                 AtomicReferenceFieldUpdater.newUpdater(AbstractPathArgument.class, Integer.class, "hash");
 379         private static final long serialVersionUID = -4546547994250849340L;
 380         private final QName nodeType;
 381         private volatile transient Integer hash = null;
 382
 383         protected AbstractPathArgument(final QName nodeType) {
 384             this.nodeType = Preconditions.checkNotNull(nodeType);
 385         }
 386
 387         @Override
 388         public final QName getNodeType() {
 389             return nodeType;
 390         }
 391
 392         @Override
 393         public int compareTo(final PathArgument o) {
 394             return nodeType.compareTo(o.getNodeType());
 395         }
 396
 397         protected int hashCodeImpl() {
 398             return 31 + getNodeType().hashCode();
 399         }
 400
 401         @Override
 402         public final int hashCode() {
 403             Integer ret = hash;
 404             if (ret == null) {
 405                 ret = hashCodeImpl();
 406                 HASH_UPDATER.lazySet(this, ret);
 407             }
 408
 409             return ret;
 410         }
 411
 412         @Override
 413         public boolean equals(final Object obj) {
 414             if (this == obj) {
 415                 return true;
 416             }
 417             if (obj == null || this.getClass() != obj.getClass()) {
 418                 return false;
 419             }
 420
 421             return getNodeType().equals(((AbstractPathArgument)obj).getNodeType());
 422         }
 423
 424         @Override
 425         public String toString() {
 426             return getNodeType().toString();
 427         }
 428
 429         @Override
 430         public String toRelativeString(final PathArgument previous) {
 431             if (previous instanceof AbstractPathArgument) {
 432                 final QNameModule mod = ((AbstractPathArgument)previous).getNodeType().getModule();
 433                 if (getNodeType().getModule().equals(mod)) {
 434                     return getNodeType().getLocalName();
 435                 }
 436             }
 437
 438             return getNodeType().toString();
 439         }
 440     }
 441
 442     /**
 443      *
 444      * Fluent Builder of Instance Identifier instances
 445      *
 446      * @
 447      *
 448      */
 449     public interface InstanceIdentifierBuilder extends Builder<YangInstanceIdentifier> {
 450         /**
 451          * Adds {@link NodeIdentifier} with supplied QName to path arguments of resulting instance identifier.
 452          *
 453          * @param nodeType QName of {@link NodeIdentifier} which will be added
 454          * @return this builder
 455          */
 456         InstanceIdentifierBuilder node(QName nodeType);
 457
 458         /**
 459          * Adds {@link NodeIdentifierWithPredicates} with supplied QName and key values to path arguments of resulting instance identifier.
 460          *
 461          * @param nodeType QName of {@link NodeIdentifierWithPredicates} which will be added
 462          * @param keyValues Map of key components and their respective values for {@link NodeIdentifierWithPredicates}
 463          * @return this builder
 464          */
 465         InstanceIdentifierBuilder nodeWithKey(QName nodeType, Map<QName, Object> keyValues);
 466
 467         /**
 468          * Adds {@link NodeIdentifierWithPredicates} with supplied QName and key, value.
 469          *
 470          * @param nodeType QName of {@link NodeIdentifierWithPredicates} which will be added
 471          * @param key QName of key which will be added
 472          * @param value value of key which will be added
 473          * @return this builder
 474          */
 475         InstanceIdentifierBuilder nodeWithKey(QName nodeType, QName key, Object value);
 476
 477         /**
 478          *
 479          * Builds an {@link YangInstanceIdentifier} with path arguments from this builder
 480          *
 481          * @return {@link YangInstanceIdentifier}
 482          */
 483         YangInstanceIdentifier build();
 484     }
 485
 486     /**
 487      * Simple path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.ContainerNode} or
 488      * {@link org.opendaylight.yangtools.yang.data.api.schema.LeafNode} leaf in particular subtree.
 489      */
 490     public static final class NodeIdentifier extends AbstractPathArgument {
 491         private static final long serialVersionUID = -2255888212390871347L;
 492
 493         public NodeIdentifier(final QName node) {
 494             super(node);
 495         }
 496     }
 497
 498     /**
 499      * Composite path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode} leaf
 500      * overall data tree.
 501      */
 502     public static final class NodeIdentifierWithPredicates extends AbstractPathArgument {
 503         private static final long serialVersionUID = -4787195606494761540L;
 504
 505         private final Map<QName, Object> keyValues;
 506
 507         public NodeIdentifierWithPredicates(final QName node, final Map<QName, Object> keyValues) {
 508             super(node);
 509             this.keyValues = ImmutableMap.copyOf(keyValues);
 510         }
 511
 512         public NodeIdentifierWithPredicates(final QName node, final QName key, final Object value) {
 513             this(node, ImmutableMap.of(key, value));
 514         }
 515
 516         public Map<QName, Object> getKeyValues() {
 517             return keyValues;
 518         }
 519
 520         @Override
 521         protected int hashCodeImpl() {
 522             final int prime = 31;
 523             int result = super.hashCodeImpl();
 524             result = prime * result;
 525
 526             for (Entry<QName, Object> entry : keyValues.entrySet()) {
 527                 result += Objects.hashCode(entry.getKey()) + YangInstanceIdentifier.hashCode(entry.getValue());
 528             }
 529             return result;
 530         }
 531
 532         @Override
 533         public boolean equals(final Object obj) {
 534             if (!super.equals(obj)) {
 535                 return false;
 536             }
 537
 538             final Map<QName, Object> otherKeyValues = ((NodeIdentifierWithPredicates) obj).keyValues;
 539             if (keyValues.size() != otherKeyValues.size()) {
 540                 return false;
 541             }
 542
 543             for (Entry<QName, Object> entry : keyValues.entrySet()) {
 544                 if (!otherKeyValues.containsKey(entry.getKey())
 545                         || !Objects.deepEquals(entry.getValue(), otherKeyValues.get(entry.getKey()))) {
 546
 547                     return false;
 548                 }
 549             }
 550
 551             return true;
 552         }
 553
 554         @Override
 555         public String toString() {
 556             return super.toString() + '[' + keyValues + ']';
 557         }
 558
 559         @Override
 560         public String toRelativeString(final PathArgument previous) {
 561             return super.toRelativeString(previous) + '[' + keyValues + ']';
 562         }
 563     }
 564
 565     /**
 566      * Simple path argument identifying a {@link LeafSetEntryNode} leaf
 567      * overall data tree.
 568      */
 569     public static final class NodeWithValue extends AbstractPathArgument {
 570         private static final long serialVersionUID = -3637456085341738431L;
 571
 572         private final Object value;
 573
 574         public NodeWithValue(final QName node, final Object value) {
 575             super(node);
 576             this.value = value;
 577         }
 578
 579         public Object getValue() {
 580             return value;
 581         }
 582
 583         @Override
 584         protected int hashCodeImpl() {
 585             final int prime = 31;
 586             int result = super.hashCodeImpl();
 587             result = prime * result + ((value == null) ? 0 : YangInstanceIdentifier.hashCode(value));
 588             return result;
 589         }
 590
 591         @Override
 592         public boolean equals(final Object obj) {
 593             if (!super.equals(obj)) {
 594                 return false;
 595             }
 596             final NodeWithValue other = (NodeWithValue) obj;
 597             return Objects.deepEquals(value, other.value);
 598         }
 599
 600         @Override
 601         public String toString() {
 602             return super.toString() + '[' + value + ']';
 603         }
 604
 605         @Override
 606         public String toRelativeString(final PathArgument previous) {
 607             return super.toRelativeString(previous) + '[' + value + ']';
 608         }
 609     }
 610
 611     /**
 612      * Composite path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode} node in
 613      * particular subtree.
 614      *
 615      * Augmentation is uniquely identified by set of all possible child nodes.
 616      * This is possible
 617      * to identify instance of augmentation,
 618      * since RFC6020 states that <code>augment</code> that augment
 619      * statement must not add multiple nodes from same namespace
 620      * / module to the target node.
 621      *
 622      *
 623      * @see <a href="http://tools.ietf.org/html/rfc6020#section-7.15">RFC6020</a>
 624      */
 625     public static final class AugmentationIdentifier implements PathArgument {
 626         private static final long serialVersionUID = -8122335594681936939L;
 627         private final ImmutableSet<QName> childNames;
 628
 629         @Override
 630         public QName getNodeType() {
 631             // This should rather throw exception than return always null
 632             throw new UnsupportedOperationException("Augmentation node has no QName");
 633         }
 634
 635         /**
 636          *
 637          * Construct new augmentation identifier using supplied set of possible
 638          * child nodes
 639          *
 640          * @param childNames
 641          *            Set of possible child nodes.
 642          */
 643         public AugmentationIdentifier(final Set<QName> childNames) {
 644             this.childNames = ImmutableSet.copyOf(childNames);
 645         }
 646
 647         /**
 648          * Augmentation node has no QName
 649          *
 650          * @deprecated Use {@link #AugmentationIdentifier(Set)} instead.
 651          */
 652         @Deprecated
 653         public AugmentationIdentifier(final QName nodeType, final Set<QName> childNames) {
 654             this(childNames);
 655         }
 656
 657         /**
 658          * Returns set of all possible child nodes
 659          *
 660          * @return set of all possible child nodes.
 661          */
 662         public Set<QName> getPossibleChildNames() {
 663             return childNames;
 664         }
 665
 666         @Override
 667         public String toString() {
 668             final StringBuffer sb = new StringBuffer("AugmentationIdentifier{");
 669             sb.append("childNames=").append(childNames).append('}');
 670             return sb.toString();
 671         }
 672
 673         @Override
 674         public String toRelativeString(final PathArgument previous) {
 675             return toString();
 676         }
 677
 678         @Override
 679         public boolean equals(final Object o) {
 680             if (this == o) {
 681                 return true;
 682             }
 683             if (!(o instanceof AugmentationIdentifier)) {
 684                 return false;
 685             }
 686
 687             AugmentationIdentifier that = (AugmentationIdentifier) o;
 688             return childNames.equals(that.childNames);
 689         }
 690
 691         @Override
 692         public int hashCode() {
 693             return childNames.hashCode();
 694         }
 695
 696         @Override
 697         public int compareTo(final PathArgument o) {
 698             if (!(o instanceof AugmentationIdentifier)) {
 699                 return -1;
 700             }
 701             AugmentationIdentifier other = (AugmentationIdentifier) o;
 702             Set<QName> otherChildNames = other.getPossibleChildNames();
 703             int thisSize = childNames.size();
 704             int otherSize = otherChildNames.size();
 705             if (thisSize == otherSize) {
 706                 Iterator<QName> otherIterator = otherChildNames.iterator();
 707                 for (QName name : childNames) {
 708                     int c = name.compareTo(otherIterator.next());
 709                     if (c != 0) {
 710                         return c;
 711                     }
 712                 }
 713                 return 0;
 714             } else if (thisSize < otherSize) {
 715                 return 1;
 716             } else {
 717                 return -1;
 718             }
 719         }
 720     }
 721
 722     private static class BuilderImpl implements InstanceIdentifierBuilder {
 723         private final HashCodeBuilder<PathArgument> hash;
 724         private final List<PathArgument> path;
 725
 726         public BuilderImpl() {
 727             this.hash = new HashCodeBuilder<>();
 728             this.path = new ArrayList<>();
 729         }
 730
 731         public BuilderImpl(final Iterable<PathArgument> prefix, final int hash) {
 732             this.path = Lists.newArrayList(prefix);
 733             this.hash = new HashCodeBuilder<>(hash);
 734         }
 735
 736         @Override
 737         public InstanceIdentifierBuilder node(final QName nodeType) {
 738             final PathArgument arg = new NodeIdentifier(nodeType);
 739             path.add(arg);
 740             hash.addArgument(arg);
 741             return this;
 742         }
 743
 744         @Override
 745         public InstanceIdentifierBuilder nodeWithKey(final QName nodeType, final QName key, final Object value) {
 746             final PathArgument arg = new NodeIdentifierWithPredicates(nodeType, key, value);
 747             path.add(arg);
 748             hash.addArgument(arg);
 749             return this;
 750         }
 751
 752         @Override
 753         public InstanceIdentifierBuilder nodeWithKey(final QName nodeType, final Map<QName, Object> keyValues) {
 754             final PathArgument arg = new NodeIdentifierWithPredicates(nodeType, keyValues);
 755             path.add(arg);
 756             hash.addArgument(arg);
 757             return this;
 758         }
 759
 760         @Override
 761         @Deprecated
 762         public YangInstanceIdentifier toInstance() {
 763             return build();
 764         }
 765
 766         @Override
 767         public YangInstanceIdentifier build() {
 768             return new YangInstanceIdentifier(ImmutableList.copyOf(path), hash.toInstance());
 769         }
 770     }
 771
 772     @Override
 773     public boolean contains(final YangInstanceIdentifier other) {
 774         Preconditions.checkArgument(other != null, "other should not be null");
 775
 776         final Iterator<?> lit = pathArguments.iterator();
 777         final Iterator<?> oit = other.pathArguments.iterator();
 778
 779         while (lit.hasNext()) {
 780             if (!oit.hasNext()) {
 781                 return false;
 782             }
 783
 784             if (!lit.next().equals(oit.next())) {
 785                 return false;
 786             }
 787         }
 788
 789         return true;
 790     }
 791
 792     @Override
 793     public String toString() {
 794         /*
 795          * The toStringCache is safe, since the object contract requires
 796          * immutability of the object and all objects referenced from this
 797          * object.
 798          * Used lists, maps are immutable. Path Arguments (elements) are also
 799          * immutable, since the PathArgument contract requires immutability.
 800          * The cache is thread-safe - if multiple computations occurs at the
 801          * same time, cache will be overwritten with same result.
 802          */
 803         String ret = toStringCache;
 804         if (ret == null) {
 805             final StringBuilder builder = new StringBuilder("/");
 806             PathArgument prev = null;
 807             for (PathArgument argument : getPathArguments()) {
 808                 if (prev != null) {
 809                     builder.append('/');
 810                 }
 811                 builder.append(argument.toRelativeString(prev));
 812                 prev = argument;
 813             }
 814
 815             ret = builder.toString();
 816             TOSTRINGCACHE_UPDATER.lazySet(this, ret);
 817         }
 818         return ret;
 819     }
 820
 821     private void readObject(final ObjectInputStream inputStream) throws IOException, ClassNotFoundException {
 822         inputStream.defaultReadObject();
 823
 824         try {
 825             PATHARGUMENTS_FIELD.set(this, legacyPath);
 826         } catch (IllegalArgumentException | IllegalAccessException e) {
 827             throw new IOException(e);
 828         }
 829     }
 830
 831     private void writeObject(final ObjectOutputStream outputStream) throws IOException {
 832         /*
 833          * This may look strange, but what we are doing here is side-stepping the fact
 834          * that pathArguments is not generally serializable. We are forcing instantiation
 835          * of the legacy path, which is an ImmutableList (thus Serializable) and write
 836          * it out. The read path does the opposite -- it reads the legacyPath and then
 837          * uses invocation API to set the field.
 838          */
 839         getLegacyPath();
 840         outputStream.defaultWriteObject();
 841     }
 842 }