2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.data.api;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Verify.verify;
12 import static java.util.Objects.requireNonNull;
14 import com.google.common.annotations.Beta;
15 import com.google.common.cache.CacheBuilder;
16 import com.google.common.cache.CacheLoader;
17 import com.google.common.cache.LoadingCache;
18 import com.google.common.collect.ImmutableList;
19 import com.google.common.collect.ImmutableMap;
20 import com.google.common.collect.ImmutableSet;
21 import com.google.common.collect.Iterables;
22 import com.google.common.collect.Sets;
23 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
24 import java.io.Serializable;
25 import java.lang.reflect.Array;
26 import java.util.AbstractMap.SimpleImmutableEntry;
27 import java.util.ArrayList;
28 import java.util.Arrays;
29 import java.util.Collection;
30 import java.util.Deque;
31 import java.util.Iterator;
32 import java.util.List;
34 import java.util.Map.Entry;
35 import java.util.Objects;
36 import java.util.Optional;
38 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
39 import java.util.function.Function;
40 import org.eclipse.jdt.annotation.NonNull;
41 import org.eclipse.jdt.annotation.Nullable;
42 import org.opendaylight.yangtools.concepts.Builder;
43 import org.opendaylight.yangtools.concepts.Immutable;
44 import org.opendaylight.yangtools.concepts.Path;
45 import org.opendaylight.yangtools.util.HashCodeBuilder;
46 import org.opendaylight.yangtools.util.ImmutableOffsetMap;
47 import org.opendaylight.yangtools.util.SharedSingletonMap;
48 import org.opendaylight.yangtools.util.SingletonSet;
49 import org.opendaylight.yangtools.yang.common.QName;
50 import org.opendaylight.yangtools.yang.common.QNameModule;
51 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
54 * Unique identifier of a particular node instance in the data tree.
57 * Java representation of YANG Built-in type <code>instance-identifier</code>,
58 * which conceptually is XPath expression minimized to uniquely identify element
59 * in data tree which conforms to constraints maintained by YANG Model,
60 * effectively this makes Instance Identifier a path to element in data tree.
63 * Constraints put in YANG specification on instance-identifier allowed it to be
64 * effectively represented in Java and it's evaluation does not require
65 * full-blown XPath processor.
68 * <h3>Path Arguments</h3>
69 * Path to the node represented in instance identifier consists of
70 * {@link PathArgument} which carries necessary information to uniquely identify
71 * node on particular level in the subtree.
74 * <li>{@link NodeIdentifier} - Identifier of node, which has cardinality
75 * <code>0..1</code> in particular subtree in data tree.</li>
76 * <li>{@link NodeIdentifierWithPredicates} - Identifier of node (list item),
77 * which has cardinality <code>0..n</code>.</li>
78 * <li>{@link NodeWithValue} - Identifier of instance <code>leaf</code> node or
79 * <code>leaf-list</code> node.</li>
80 * <li>{@link AugmentationIdentifier} - Identifier of instance of
81 * <code>augmentation</code> node.</li>
84 * @see <a href="http://tools.ietf.org/html/rfc6020#section-9.13">RFC6020</a>
86 // FIXME: 6.0.0: this concept needs to be moved to yang-common, as parser components need the ability to refer
87 // to data nodes -- most notably XPath expressions and {@code default} statement arguments need to be able
88 // to represent these.
89 public abstract class YangInstanceIdentifier implements Path<YangInstanceIdentifier>, Immutable, Serializable {
90 private static final AtomicReferenceFieldUpdater<YangInstanceIdentifier, String> TOSTRINGCACHE_UPDATER =
91 AtomicReferenceFieldUpdater.newUpdater(YangInstanceIdentifier.class, String.class, "toStringCache");
92 private static final long serialVersionUID = 4L;
94 private final int hash;
95 private transient volatile String toStringCache = null;
97 // Package-private to prevent outside subclassing
98 YangInstanceIdentifier(final int hash) {
103 * Return An empty {@link YangInstanceIdentifier}. It corresponds to the path of the conceptual root of the YANG
106 * @return An empty YangInstanceIdentifier
108 public static @NonNull YangInstanceIdentifier empty() {
109 return FixedYangInstanceIdentifier.EMPTY_INSTANCE;
112 abstract @NonNull YangInstanceIdentifier createRelativeIdentifier(int skipFromRoot);
114 abstract @Nullable Collection<PathArgument> tryPathArguments();
116 abstract @Nullable Collection<PathArgument> tryReversePathArguments();
119 * Check if this instance identifier has empty path arguments, e.g. it is
120 * empty and corresponds to {@link #empty()}.
122 * @return True if this instance identifier is empty, false otherwise.
124 public abstract boolean isEmpty();
127 * Return an optimized version of this identifier, useful when the identifier
128 * will be used very frequently.
130 * @return A optimized equivalent instance.
133 public abstract @NonNull YangInstanceIdentifier toOptimized();
136 * Return the conceptual parent {@link YangInstanceIdentifier}, which has
137 * one item less in {@link #getPathArguments()}.
139 * @return Parent {@link YangInstanceIdentifier}, or null if this object is {@link #empty()}.
141 public abstract @Nullable YangInstanceIdentifier getParent();
144 * Return the ancestor {@link YangInstanceIdentifier} with a particular depth, e.g. number of path arguments.
146 * @param depth Ancestor depth
147 * @return Ancestor {@link YangInstanceIdentifier}
148 * @throws IllegalArgumentException if the specified depth is negative or is greater than the depth of this object.
150 public abstract @NonNull YangInstanceIdentifier getAncestor(int depth);
153 * Returns an ordered iteration of path arguments.
155 * @return Immutable iteration of path arguments.
157 public abstract @NonNull List<PathArgument> getPathArguments();
160 * Returns an iterable of path arguments in reverse order. This is useful
161 * when walking up a tree organized this way.
163 * @return Immutable iterable of path arguments in reverse order.
165 public abstract @NonNull List<PathArgument> getReversePathArguments();
168 * Returns the last PathArgument. This is equivalent of iterating
169 * to the last element of the iterable returned by {@link #getPathArguments()}.
171 * @return The last past argument, or null if there are no PathArguments.
173 public abstract PathArgument getLastPathArgument();
175 public static @NonNull YangInstanceIdentifier create(final Iterable<? extends PathArgument> path) {
176 if (Iterables.isEmpty(path)) {
180 final HashCodeBuilder<PathArgument> hash = new HashCodeBuilder<>();
181 for (PathArgument a : path) {
185 return FixedYangInstanceIdentifier.create(path, hash.build());
188 public static @NonNull YangInstanceIdentifier create(final PathArgument... path) {
189 // We are forcing a copy, since we cannot trust the user
190 return create(Arrays.asList(path));
194 * Create a {@link YangInstanceIdentifier} by taking a snapshot of provided path and iterating it backwards.
196 * @param pathTowardsRoot Path towards root
197 * @return A {@link YangInstanceIdentifier} instance
198 * @throws NullPointerException if {@code pathTowardsRoot} or any of its members is null
200 public static @NonNull YangInstanceIdentifier createReverse(final Deque<PathArgument> pathTowardsRoot) {
201 final ImmutableList.Builder<PathArgument> builder = ImmutableList.builderWithExpectedSize(
202 pathTowardsRoot.size());
203 pathTowardsRoot.descendingIterator().forEachRemaining(builder::add);
204 return YangInstanceIdentifier.create(builder.build());
208 * Create a {@link YangInstanceIdentifier} by walking specified stack backwards and extracting path components
211 * @param stackTowardsRoot Stack towards root,
212 * @return A {@link YangInstanceIdentifier} instance
213 * @throws NullPointerException if {@code pathTowardsRoot} is null
215 public static <T> @NonNull YangInstanceIdentifier createReverse(final Deque<? extends T> stackTowardsRoot,
216 final Function<T, PathArgument> function) {
217 final ImmutableList.Builder<PathArgument> builder = ImmutableList.builderWithExpectedSize(
218 stackTowardsRoot.size());
219 final Iterator<? extends T> it = stackTowardsRoot.descendingIterator();
220 while (it.hasNext()) {
221 builder.add(function.apply(it.next()));
223 return YangInstanceIdentifier.create(builder.build());
226 boolean pathArgumentsEqual(final YangInstanceIdentifier other) {
227 return Iterables.elementsEqual(getPathArguments(), other.getPathArguments());
231 public boolean equals(final Object obj) {
235 if (!(obj instanceof YangInstanceIdentifier)) {
238 YangInstanceIdentifier other = (YangInstanceIdentifier) obj;
239 if (this.hashCode() != obj.hashCode()) {
243 return pathArgumentsEqual(other);
247 * Constructs a new Instance Identifier with new {@link NodeIdentifier} added to the end of path arguments.
249 * @param name QName of {@link NodeIdentifier}
250 * @return Instance Identifier with additional path argument added to the end.
252 public final @NonNull YangInstanceIdentifier node(final QName name) {
253 return node(new NodeIdentifier(name));
257 * Constructs a new Instance Identifier with new {@link PathArgument} added to the end of path arguments.
259 * @param arg Path argument which should be added to the end
260 * @return Instance Identifier with additional path argument added to the end.
262 public final @NonNull YangInstanceIdentifier node(final PathArgument arg) {
263 return new StackedYangInstanceIdentifier(this, arg, HashCodeBuilder.nextHashCode(hash, arg));
267 * Get the relative path from an ancestor. This method attempts to perform
268 * the reverse of concatenating a base (ancestor) and a path.
271 * Ancestor against which the relative path should be calculated
272 * @return This object's relative path from parent, or Optional.absent() if
273 * the specified parent is not in fact an ancestor of this object.
275 public Optional<YangInstanceIdentifier> relativeTo(final YangInstanceIdentifier ancestor) {
276 if (this == ancestor) {
277 return Optional.of(empty());
279 if (ancestor.isEmpty()) {
280 return Optional.of(this);
283 final Iterator<PathArgument> lit = getPathArguments().iterator();
284 final Iterator<PathArgument> oit = ancestor.getPathArguments().iterator();
287 while (oit.hasNext()) {
288 // Ancestor is not really an ancestor
289 if (!lit.hasNext() || !lit.next().equals(oit.next())) {
290 return Optional.empty();
297 return Optional.of(this);
299 if (!lit.hasNext()) {
300 return Optional.of(empty());
303 return Optional.of(createRelativeIdentifier(common));
307 public final boolean contains(final YangInstanceIdentifier other) {
312 checkArgument(other != null, "other should not be null");
313 final Iterator<PathArgument> lit = getPathArguments().iterator();
314 final Iterator<PathArgument> oit = other.getPathArguments().iterator();
316 while (lit.hasNext()) {
317 if (!oit.hasNext()) {
321 if (!lit.next().equals(oit.next())) {
330 public final String toString() {
332 * The toStringCache is safe, since the object contract requires
333 * immutability of the object and all objects referenced from this
335 * Used lists, maps are immutable. Path Arguments (elements) are also
336 * immutable, since the PathArgument contract requires immutability.
337 * The cache is thread-safe - if multiple computations occurs at the
338 * same time, cache will be overwritten with same result.
340 String ret = toStringCache;
342 final StringBuilder builder = new StringBuilder("/");
343 PathArgument prev = null;
344 for (PathArgument argument : getPathArguments()) {
348 builder.append(argument.toRelativeString(prev));
352 ret = builder.toString();
353 TOSTRINGCACHE_UPDATER.lazySet(this, ret);
359 public final int hashCode() {
361 * The caching is safe, since the object contract requires
362 * immutability of the object and all objects referenced from this
364 * Used lists, maps are immutable. Path Arguments (elements) are also
365 * immutable, since the PathArgument contract requires immutability.
370 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
371 justification = "https://github.com/spotbugs/spotbugs/issues/811")
372 private static int hashCode(final Object value) {
377 if (byte[].class.equals(value.getClass())) {
378 return Arrays.hashCode((byte[]) value);
381 if (value.getClass().isArray()) {
383 int length = Array.getLength(value);
384 for (int i = 0; i < length; i++) {
385 hash += Objects.hashCode(Array.get(value, i));
391 return Objects.hashCode(value);
394 final Object writeReplace() {
395 return new YIDv1(this);
398 // Static factories & helpers
401 * Returns a new InstanceIdentifier with only one path argument of type {@link NodeIdentifier} with supplied
404 * @param name QName of first node identifier
405 * @return Instance Identifier with only one path argument of type {@link NodeIdentifier}
407 public static @NonNull YangInstanceIdentifier of(final QName name) {
408 return create(new NodeIdentifier(name));
412 * Returns new builder for InstanceIdentifier with empty path arguments.
414 * @return new builder for InstanceIdentifier with empty path arguments.
416 public static @NonNull InstanceIdentifierBuilder builder() {
417 return new YangInstanceIdentifierBuilder();
421 * Returns new builder for InstanceIdentifier with path arguments copied from original instance identifier.
423 * @param origin InstanceIdentifier from which path arguments are copied.
424 * @return new builder for InstanceIdentifier with path arguments copied from original instance identifier.
426 public static @NonNull InstanceIdentifierBuilder builder(final YangInstanceIdentifier origin) {
427 return new YangInstanceIdentifierBuilder(origin.getPathArguments(), origin.hashCode());
431 * Path argument / component of InstanceIdentifier.
432 * Path argument uniquely identifies node in data tree on particular
436 * This interface itself is used as common parent for actual
437 * path arguments types and should not be implemented by user code.
440 * Path arguments SHOULD contain only minimum of information
441 * required to uniquely identify node on particular subtree level.
444 * For actual path arguments types see:
446 * <li>{@link NodeIdentifier} - Identifier of container or leaf
447 * <li>{@link NodeIdentifierWithPredicates} - Identifier of list entries, which have key defined
448 * <li>{@link AugmentationIdentifier} - Identifier of augmentation
449 * <li>{@link NodeWithValue} - Identifier of leaf-list entry
452 public interface PathArgument extends Comparable<PathArgument>, Immutable, Serializable {
454 * Returns unique QName of data node as defined in YANG Schema, if available.
457 * @throws UnsupportedOperationException if node type is not applicable, for example in case of an augmentation.
459 @NonNull QName getNodeType();
462 * Return the string representation of this object for use in context
463 * provided by a previous object. This method can be implemented in
464 * terms of {@link #toString()}, but implementations are encourage to
465 * reuse any context already emitted by the previous object.
467 * @param previous Previous path argument
468 * @return String representation
470 @NonNull String toRelativeString(PathArgument previous);
473 private abstract static class AbstractPathArgument implements PathArgument {
474 private static final long serialVersionUID = -4546547994250849340L;
475 private final @NonNull QName nodeType;
476 private transient volatile int hashValue;
478 protected AbstractPathArgument(final QName nodeType) {
479 this.nodeType = requireNonNull(nodeType);
483 public final QName getNodeType() {
488 @SuppressWarnings("checkstyle:parameterName")
489 public int compareTo(final PathArgument o) {
490 return nodeType.compareTo(o.getNodeType());
493 protected int hashCodeImpl() {
494 return nodeType.hashCode();
498 public final int hashCode() {
500 return (local = hashValue) != 0 ? local : (hashValue = hashCodeImpl());
504 public boolean equals(final Object obj) {
508 if (obj == null || this.getClass() != obj.getClass()) {
512 return getNodeType().equals(((AbstractPathArgument)obj).getNodeType());
516 public String toString() {
517 return getNodeType().toString();
521 public String toRelativeString(final PathArgument previous) {
522 if (previous instanceof AbstractPathArgument) {
523 final QNameModule mod = previous.getNodeType().getModule();
524 if (getNodeType().getModule().equals(mod)) {
525 return getNodeType().getLocalName();
529 return getNodeType().toString();
532 abstract Object writeReplace();
536 * Simple path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.ContainerNode} or
537 * {@link org.opendaylight.yangtools.yang.data.api.schema.LeafNode} leaf in particular subtree.
539 public static final class NodeIdentifier extends AbstractPathArgument {
540 private static final long serialVersionUID = -2255888212390871347L;
541 private static final LoadingCache<QName, NodeIdentifier> CACHE = CacheBuilder.newBuilder().weakValues()
542 .build(new CacheLoader<QName, NodeIdentifier>() {
544 public NodeIdentifier load(final QName key) {
545 return new NodeIdentifier(key);
549 public NodeIdentifier(final QName node) {
554 * Return a NodeIdentifier for a particular QName. Unlike the constructor, this factory method uses a global
555 * instance cache, resulting in object reuse for equal inputs.
557 * @param node Node's QName
558 * @return A {@link NodeIdentifier}
560 public static @NonNull NodeIdentifier create(final QName node) {
561 return CACHE.getUnchecked(node);
565 Object writeReplace() {
566 return new NIv1(this);
571 * Composite path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode} leaf
574 public abstract static class NodeIdentifierWithPredicates extends AbstractPathArgument {
576 public static final class Singleton extends NodeIdentifierWithPredicates {
577 private static final long serialVersionUID = 1L;
579 private final @NonNull QName key;
580 private final @NonNull Object value;
582 Singleton(final QName node, final QName key, final Object value) {
584 this.key = requireNonNull(key);
585 this.value = requireNonNull(value);
589 public SingletonSet<Entry<QName, Object>> entrySet() {
590 return SingletonSet.of(singleEntry());
594 public SingletonSet<QName> keySet() {
595 return SingletonSet.of(key);
599 public boolean containsKey(final QName qname) {
600 return key.equals(requireNonNull(qname));
604 public SingletonSet<Object> values() {
605 return SingletonSet.of(value);
614 public ImmutableMap<QName, Object> asMap() {
615 return ImmutableMap.of(key, value);
619 * Return the single entry contained in this object. This is equivalent to
620 * {@code entrySet().iterator().next()}.
622 * @return A single entry.
624 public @NonNull Entry<QName, Object> singleEntry() {
625 return new SimpleImmutableEntry<>(key, value);
629 boolean equalMapping(final NodeIdentifierWithPredicates other) {
630 final Singleton single = (Singleton) other;
631 return key.equals(single.key) && Objects.deepEquals(value, single.value);
635 Object keyValue(final QName qname) {
636 return key.equals(qname) ? value : null;
640 private static final class Regular extends NodeIdentifierWithPredicates {
641 private static final long serialVersionUID = 1L;
643 private final @NonNull Map<QName, Object> keyValues;
645 Regular(final QName node, final Map<QName, Object> keyValues) {
647 this.keyValues = requireNonNull(keyValues);
651 public Set<Entry<QName, Object>> entrySet() {
652 return keyValues.entrySet();
656 public Set<QName> keySet() {
657 return keyValues.keySet();
661 public boolean containsKey(final QName qname) {
662 return keyValues.containsKey(requireNonNull(qname));
666 public Collection<Object> values() {
667 return keyValues.values();
672 return keyValues.size();
676 public Map<QName, Object> asMap() {
681 Object keyValue(final QName qname) {
682 return keyValues.get(qname);
686 boolean equalMapping(final NodeIdentifierWithPredicates other) {
687 final Map<QName, Object> otherKeyValues = ((Regular) other).keyValues;
688 // TODO: benchmark to see if just calling equals() on the two maps is not faster
689 if (keyValues == otherKeyValues) {
692 if (keyValues.size() != otherKeyValues.size()) {
696 for (Entry<QName, Object> entry : entrySet()) {
697 final Object otherValue = otherKeyValues.get(entry.getKey());
698 if (otherValue == null || !Objects.deepEquals(entry.getValue(), otherValue)) {
707 private static final long serialVersionUID = -4787195606494761540L;
709 NodeIdentifierWithPredicates(final QName node) {
713 public static @NonNull NodeIdentifierWithPredicates of(final QName node) {
714 return new Regular(node, ImmutableMap.of());
717 public static @NonNull NodeIdentifierWithPredicates of(final QName node, final QName key, final Object value) {
718 return new Singleton(node, key, value);
721 public static @NonNull NodeIdentifierWithPredicates of(final QName node, final Entry<QName, Object> entry) {
722 return of(node, entry.getKey(), entry.getValue());
725 public static @NonNull NodeIdentifierWithPredicates of(final QName node, final Map<QName, Object> keyValues) {
726 return keyValues.size() == 1 ? of(keyValues, node)
727 // Retains ImmutableMap for empty maps. For larger sizes uses a shared key set.
728 : new Regular(node, ImmutableOffsetMap.unorderedCopyOf(keyValues));
731 public static @NonNull NodeIdentifierWithPredicates of(final QName node,
732 final ImmutableOffsetMap<QName, Object> keyValues) {
733 return keyValues.size() == 1 ? of(keyValues, node) : new Regular(node, keyValues);
737 public static @NonNull NodeIdentifierWithPredicates of(final QName node,
738 final SharedSingletonMap<QName, Object> keyValues) {
739 return of(node, keyValues.getEntry());
742 private static @NonNull NodeIdentifierWithPredicates of(final Map<QName, Object> keyValues, final QName node) {
743 return of(node, keyValues.entrySet().iterator().next());
747 * Return the set of predicates keys and values. Keys are guaranteeed to be unique.
749 * @return Predicate set.
752 public abstract @NonNull Set<Entry<QName, Object>> entrySet();
755 * Return the predicate key in the iteration order of {@link #entrySet()}.
757 * @return Predicate values.
760 public abstract @NonNull Set<QName> keySet();
763 * Determine whether a particular predicate key is present.
765 * @param key Predicate key
766 * @return True if the predicate is present, false otherwise
767 * @throws NullPointerException if {@code key} is null
770 public abstract boolean containsKey(QName key);
773 * Return the predicate values in the iteration order of {@link #entrySet()}.
775 * @return Predicate values.
778 public abstract @NonNull Collection<Object> values();
781 public final @Nullable Object getValue(final QName key) {
782 return keyValue(requireNonNull(key));
786 public final <T> @Nullable T getValue(final QName key, final Class<T> valueClass) {
787 return valueClass.cast(getValue(key));
791 * Return the number of predicates present.
793 * @return The number of predicates present.
796 public abstract int size();
799 * A Map-like view of this identifier's predicates. The view is expected to be stable and effectively-immutable.
801 * @return Map of predicates.
802 * @deprecated This method in a provisional one. It can be used in the code base, but users requiring it should
803 * contact <a href="mailto:yangtools-dev@lists.opendaylight.org">yangtools-dev</a> for migration
804 * guidelines. Callers are strongly encouraged to explore {@link #entrySet()}, {@link #size()},
805 * {@link #values()} and {@link #keySet()} as an alternative.
809 // FIXME: 6.0.0: evaluate the real usefulness of this. The problem here is Map.hashCode() and Map.equals(),
810 // which limits our options.
811 public abstract @NonNull Map<QName, Object> asMap();
814 protected final int hashCodeImpl() {
815 int result = 31 * super.hashCodeImpl();
816 for (Entry<QName, Object> entry : entrySet()) {
817 result += entry.getKey().hashCode() + YangInstanceIdentifier.hashCode(entry.getValue());
823 @SuppressWarnings("checkstyle:equalsHashCode")
824 public final boolean equals(final Object obj) {
825 return super.equals(obj) && equalMapping((NodeIdentifierWithPredicates) obj);
828 abstract boolean equalMapping(NodeIdentifierWithPredicates other);
830 abstract @Nullable Object keyValue(@NonNull QName qname);
833 public final String toString() {
834 return super.toString() + '[' + asMap() + ']';
838 public final String toRelativeString(final PathArgument previous) {
839 return super.toRelativeString(previous) + '[' + asMap() + ']';
843 final Object writeReplace() {
844 return new NIPv2(this);
849 * Simple path argument identifying a {@link LeafSetEntryNode} leaf
852 public static final class NodeWithValue<T> extends AbstractPathArgument {
853 private static final long serialVersionUID = -3637456085341738431L;
855 private final T value;
857 public NodeWithValue(final QName node, final T value) {
862 public T getValue() {
867 protected int hashCodeImpl() {
868 return 31 * super.hashCodeImpl() + YangInstanceIdentifier.hashCode(value);
872 @SuppressWarnings("checkstyle:equalsHashCode")
873 public boolean equals(final Object obj) {
874 if (!super.equals(obj)) {
877 final NodeWithValue<?> other = (NodeWithValue<?>) obj;
878 return Objects.deepEquals(value, other.value);
882 public String toString() {
883 return super.toString() + '[' + value + ']';
887 public String toRelativeString(final PathArgument previous) {
888 return super.toRelativeString(previous) + '[' + value + ']';
892 Object writeReplace() {
893 return new NIVv1(this);
898 * Composite path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode}
899 * node in particular subtree.
902 * Augmentation is uniquely identified by set of all possible child nodes.
904 * to identify instance of augmentation,
905 * since RFC6020 states that <code>augment</code> that augment
906 * statement must not add multiple nodes from same namespace
907 * / module to the target node.
909 * @see <a href="http://tools.ietf.org/html/rfc6020#section-7.15">RFC6020</a>
911 public static final class AugmentationIdentifier implements PathArgument {
912 private static final long serialVersionUID = -8122335594681936939L;
914 private static final LoadingCache<ImmutableSet<QName>, AugmentationIdentifier> CACHE = CacheBuilder.newBuilder()
915 .weakValues().build(new CacheLoader<ImmutableSet<QName>, AugmentationIdentifier>() {
917 public AugmentationIdentifier load(final ImmutableSet<QName> key) {
918 return new AugmentationIdentifier(key);
922 private final @NonNull ImmutableSet<QName> childNames;
925 public QName getNodeType() {
926 // This should rather throw exception than return always null
927 throw new UnsupportedOperationException("Augmentation node has no QName");
931 * Construct new augmentation identifier using supplied set of possible
935 * Set of possible child nodes.
937 public AugmentationIdentifier(final ImmutableSet<QName> childNames) {
938 this.childNames = requireNonNull(childNames);
942 * Construct new augmentation identifier using supplied set of possible
946 * Set of possible child nodes.
948 public AugmentationIdentifier(final Set<QName> childNames) {
949 this.childNames = ImmutableSet.copyOf(childNames);
953 * Return an AugmentationIdentifier for a particular set of QNames. Unlike the constructor, this factory method
954 * uses a global instance cache, resulting in object reuse for equal inputs.
956 * @param childNames Set of possible child nodes
957 * @return An {@link AugmentationIdentifier}
959 public static @NonNull AugmentationIdentifier create(final ImmutableSet<QName> childNames) {
960 return CACHE.getUnchecked(childNames);
964 * Return an AugmentationIdentifier for a particular set of QNames. Unlike the constructor, this factory method
965 * uses a global instance cache, resulting in object reuse for equal inputs.
967 * @param childNames Set of possible child nodes
968 * @return An {@link AugmentationIdentifier}
970 public static @NonNull AugmentationIdentifier create(final Set<QName> childNames) {
971 final AugmentationIdentifier existing = CACHE.getIfPresent(childNames);
972 return existing != null ? existing : create(ImmutableSet.copyOf(childNames));
976 * Returns set of all possible child nodes.
978 * @return set of all possible child nodes.
980 public @NonNull Set<QName> getPossibleChildNames() {
985 public String toString() {
986 return "AugmentationIdentifier{" + "childNames=" + childNames + '}';
990 public String toRelativeString(final PathArgument previous) {
995 public boolean equals(final Object obj) {
999 if (!(obj instanceof AugmentationIdentifier)) {
1003 AugmentationIdentifier that = (AugmentationIdentifier) obj;
1004 return childNames.equals(that.childNames);
1008 public int hashCode() {
1009 return childNames.hashCode();
1013 @SuppressWarnings("checkstyle:parameterName")
1014 public int compareTo(final PathArgument o) {
1015 if (!(o instanceof AugmentationIdentifier)) {
1018 AugmentationIdentifier other = (AugmentationIdentifier) o;
1019 Set<QName> otherChildNames = other.getPossibleChildNames();
1020 int thisSize = childNames.size();
1021 int otherSize = otherChildNames.size();
1022 if (thisSize == otherSize) {
1023 // Quick Set-based comparison
1024 if (childNames.equals(otherChildNames)) {
1028 // We already know the sets are not equal, but have equal size, hence the sets differ in their elements,
1029 // but potentially share a common set of elements. The most consistent way of comparing them is using
1030 // total ordering defined by QName's compareTo. Hence convert both sets to lists ordered
1031 // by QName.compareTo() and decide on the first differing element.
1032 final List<QName> diff = new ArrayList<>(Sets.symmetricDifference(childNames, otherChildNames));
1033 verify(!diff.isEmpty(), "Augmentation identifiers %s and %s report no difference", this, o);
1034 diff.sort(QName::compareTo);
1035 return childNames.contains(diff.get(0)) ? -1 : 1;
1036 } else if (thisSize < otherSize) {
1043 private Object writeReplace() {
1044 return new AIv1(this);
1049 * Fluent Builder of Instance Identifier instances.
1051 public interface InstanceIdentifierBuilder extends Builder<YangInstanceIdentifier> {
1053 * Adds a {@link PathArgument} to path arguments of resulting instance identifier.
1055 * @param arg A {@link PathArgument} to be added
1056 * @return this builder
1058 @NonNull InstanceIdentifierBuilder node(PathArgument arg);
1061 * Adds {@link NodeIdentifier} with supplied QName to path arguments of resulting instance identifier.
1063 * @param nodeType QName of {@link NodeIdentifier} which will be added
1064 * @return this builder
1066 @NonNull InstanceIdentifierBuilder node(QName nodeType);
1069 * Adds {@link NodeIdentifierWithPredicates} with supplied QName and key values to path arguments of resulting
1070 * instance identifier.
1072 * @param nodeType QName of {@link NodeIdentifierWithPredicates} which will be added
1073 * @param keyValues Map of key components and their respective values for {@link NodeIdentifierWithPredicates}
1074 * @return this builder
1076 @NonNull InstanceIdentifierBuilder nodeWithKey(QName nodeType, Map<QName, Object> keyValues);
1079 * Adds {@link NodeIdentifierWithPredicates} with supplied QName and key, value.
1081 * @param nodeType QName of {@link NodeIdentifierWithPredicates} which will be added
1082 * @param key QName of key which will be added
1083 * @param value value of key which will be added
1084 * @return this builder
1086 @NonNull InstanceIdentifierBuilder nodeWithKey(QName nodeType, QName key, Object value);
1089 * Adds a collection of {@link PathArgument}s to path arguments of resulting instance identifier.
1091 * @param args {@link PathArgument}s to be added
1092 * @return this builder
1093 * @throws NullPointerException if any of the arguments is null
1096 @NonNull InstanceIdentifierBuilder append(Collection<? extends PathArgument> args);
1099 * Adds a collection of {@link PathArgument}s to path arguments of resulting instance identifier.
1101 * @param args {@link PathArgument}s to be added
1102 * @return this builder
1103 * @throws NullPointerException if any of the arguments is null
1106 default @NonNull InstanceIdentifierBuilder append(final PathArgument... args) {
1107 return append(Arrays.asList(args));
1111 * Builds an {@link YangInstanceIdentifier} with path arguments from this builder.
1113 * @return {@link YangInstanceIdentifier}
1116 YangInstanceIdentifier build();