All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier Maven / Gradle / Ivy

Go to download 

/*
 * 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 static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Verify.verify;
import static java.util.Objects.requireNonNull;

import com.google.common.annotations.Beta;
import com.google.common.base.VerifyException;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Sets;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.Serializable;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Deque;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
import java.util.function.Function;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.concepts.Path;
import org.opendaylight.yangtools.util.HashCodeBuilder;
import org.opendaylight.yangtools.util.ImmutableOffsetMap;
import org.opendaylight.yangtools.util.SharedSingletonMap;
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 particular node instance in the data tree.
 *
 * 

 * Java representation of YANG Built-in type {@code instance-identifier}, which conceptually is XPath expression
 * minimized to uniquely identify element in data tree which conforms to constraints maintained by YANG Model,
 * effectively this makes Instance Identifier a path to element in data tree.
 *
 * 

 * Constraints put in YANG specification on instance-identifier allowed it to be effectively represented in Java and its
 * evaluation does not require a full-blown XPath processor.
 *
 * 
Path Arguments

 * Path to the node represented in instance identifier consists of {@link PathArgument} which carries necessary
 * information to uniquely identify node on particular level in the subtree.
 *
 * 
    
 *   
  • {@link NodeIdentifier} - Identifier of node, which has cardinality {@code 0..1} in particular subtree in data
 *       tree
    • 
 *   
  • {@link NodeIdentifierWithPredicates} - Identifier of node (list item), which has cardinality {@code 0..n}
    • 
 *   
  • {@link NodeWithValue} - Identifier of instance {@code leaf} node or {@code leaf-list} node
    • 
 *   
  • {@link AugmentationIdentifier} - Identifier of instance of {@code augmentation} node
    • 
 * 

 *
 * @see RFC6020
 */
// FIXME: 4.0.0: this concept needs to be moved to yang-common, as parser components need the ability to refer
//               to data nodes -- most notably XPath expressions and {@code default} statement arguments need to be able
//               to represent these.
// FIXME: Remove this suppression when we remove EMPTY
@SuppressFBWarnings(value = "IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION",
    justification = "Having EMPTY a constant is the trouble here")
public abstract class YangInstanceIdentifier implements Path, Immutable, Serializable {
    /**
     * An empty {@link YangInstanceIdentifier}. It corresponds to the path of the conceptual root of the YANG namespace.
     *
     * @deprecated Use {@link #empty()} instead.
     */
    @Deprecated
    public static final @NonNull YangInstanceIdentifier EMPTY = FixedYangInstanceIdentifier.EMPTY_INSTANCE;

    private static final AtomicReferenceFieldUpdater TOSTRINGCACHE_UPDATER =
            AtomicReferenceFieldUpdater.newUpdater(YangInstanceIdentifier.class, String.class, "toStringCache");
    private static final long serialVersionUID = 4L;

    private final int hash;
    private transient volatile String toStringCache = null;

    // Package-private to prevent outside subclassing
    YangInstanceIdentifier(final int hash) {
        this.hash = hash;
    }

    /**
     * Return An empty {@link YangInstanceIdentifier}. It corresponds to the path of the conceptual root of the YANG
     * namespace.
     *
     * @return An empty YangInstanceIdentifier
     */
    public static @NonNull YangInstanceIdentifier empty() {
        return FixedYangInstanceIdentifier.EMPTY_INSTANCE;
    }

    abstract @NonNull YangInstanceIdentifier createRelativeIdentifier(int skipFromRoot);

    abstract @Nullable Collection tryPathArguments();

    abstract @Nullable Collection tryReversePathArguments();

    /**
     * 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 an optimized version of this identifier, useful when the identifier
     * will be used very frequently.
     *
     * @return A optimized equivalent instance.
     */
    @Beta
    public abstract @NonNull YangInstanceIdentifier toOptimized();

    /**
     * Return the conceptual parent {@link YangInstanceIdentifier}, which has
     * one item less in {@link #getPathArguments()}.
     *
     * @return Parent {@link YangInstanceIdentifier}, or null if this object is {@link #empty()}.
     */
    public abstract @Nullable YangInstanceIdentifier getParent();

    /**
     * Return the conceptual parent {@link YangInstanceIdentifier}, which has one item less in
     * {@link #getPathArguments()}.
     *
     * @return Parent {@link YangInstanceIdentifier}
     * @throws VerifyException if this object is {@link #empty()}.
     */
    public abstract @NonNull YangInstanceIdentifier coerceParent();

    /**
     * Return the ancestor {@link YangInstanceIdentifier} with a particular depth, e.g. number of path arguments.
     *
     * @param depth Ancestor depth
     * @return Ancestor {@link YangInstanceIdentifier}
     * @throws IllegalArgumentException if the specified depth is negative or is greater than the depth of this object.
     */
    public abstract @NonNull YangInstanceIdentifier getAncestor(int depth);

    /**
     * Returns an ordered iteration of path arguments.
     *
     * @return Immutable iteration of path arguments.
     */
    public abstract @NonNull List getPathArguments();

    /**
     * Returns an iterable of path arguments in reverse order. This is useful
     * when walking up a tree organized this way.
     *
     * @return Immutable iterable of path arguments in reverse order.
     */
    public abstract @NonNull List getReversePathArguments();

    /**
     * Returns the last PathArgument. This is equivalent of iterating
     * to the last element of the iterable returned by {@link #getPathArguments()}.
     *
     * @return The last past argument, or null if there are no PathArguments.
     */
    public abstract PathArgument getLastPathArgument();

    public static @NonNull YangInstanceIdentifier create(final Iterable path) {
        if (Iterables.isEmpty(path)) {
            return empty();
        }

        final HashCodeBuilder hash = new HashCodeBuilder<>();
        for (PathArgument a : path) {
            hash.addArgument(a);
        }

        return FixedYangInstanceIdentifier.create(path, hash.build());
    }

    @Beta
    public static @NonNull YangInstanceIdentifier create(final PathArgument pathArgument) {
        return new FixedYangInstanceIdentifier(ImmutableList.of(pathArgument),
            HashCodeBuilder.nextHashCode(1, pathArgument));
    }

    public static @NonNull YangInstanceIdentifier create(final PathArgument... path) {
        // We are forcing a copy, since we cannot trust the user
        return create(Arrays.asList(path));
    }

    /**
     * Create a {@link YangInstanceIdentifier} by taking a snapshot of provided path and iterating it backwards.
     *
     * @param pathTowardsRoot Path towards root
     * @return A {@link YangInstanceIdentifier} instance
     * @throws NullPointerException if {@code pathTowardsRoot} or any of its members is null
     */
    public static @NonNull YangInstanceIdentifier createReverse(final Deque pathTowardsRoot) {
        final ImmutableList.Builder builder = ImmutableList.builderWithExpectedSize(
            pathTowardsRoot.size());
        pathTowardsRoot.descendingIterator().forEachRemaining(builder::add);
        return YangInstanceIdentifier.create(builder.build());
    }

    /**
     * Create a {@link YangInstanceIdentifier} by walking specified stack backwards and extracting path components
     * from it.
     *
     * @param stackTowardsRoot Stack towards root,
     * @return A {@link YangInstanceIdentifier} instance
     * @throws NullPointerException if {@code pathTowardsRoot} is null
     */
    public static  @NonNull YangInstanceIdentifier createReverse(final Deque stackTowardsRoot,
            final Function function) {
        final ImmutableList.Builder builder = ImmutableList.builderWithExpectedSize(
            stackTowardsRoot.size());
        final Iterator it = stackTowardsRoot.descendingIterator();
        while (it.hasNext()) {
            builder.add(function.apply(it.next()));
        }
        return YangInstanceIdentifier.create(builder.build());
    }

    boolean pathArgumentsEqual(final YangInstanceIdentifier other) {
        return Iterables.elementsEqual(getPathArguments(), other.getPathArguments());
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof YangInstanceIdentifier)) {
            return false;
        }
        YangInstanceIdentifier other = (YangInstanceIdentifier) obj;
        if (this.hashCode() != obj.hashCode()) {
            return false;
        }

        return pathArgumentsEqual(other);
    }

    /**
     * Constructs a new Instance Identifier with new {@link NodeIdentifier} added to the end of path arguments.
     *
     * @param name QName of {@link NodeIdentifier}
     * @return Instance Identifier with additional path argument added to the end.
     */
    public final @NonNull YangInstanceIdentifier node(final QName name) {
        return node(new NodeIdentifier(name));
    }

    /**
     * Constructs a new Instance Identifier with new {@link PathArgument} added to the end of path arguments.
     *
     * @param arg Path argument which should be added to the end
     * @return Instance Identifier with additional path argument added to the end.
     */
    public final @NonNull YangInstanceIdentifier node(final PathArgument arg) {
        return new StackedYangInstanceIdentifier(this, arg, HashCodeBuilder.nextHashCode(hash, arg));
    }

    /**
     * Get the relative path from an ancestor. This method attempts to perform
     * the reverse of concatenating a base (ancestor) and a path.
     *
     * @param ancestor
     *            Ancestor against which the relative path should be calculated
     * @return This object's relative path from parent, or Optional.absent() if
     *         the specified parent is not in fact an ancestor of this object.
     */
    public Optional relativeTo(final YangInstanceIdentifier ancestor) {
        if (this == ancestor) {
            return Optional.of(empty());
        }
        if (ancestor.isEmpty()) {
            return Optional.of(this);
        }

        final Iterator lit = getPathArguments().iterator();
        final Iterator oit = ancestor.getPathArguments().iterator();
        int common = 0;

        while (oit.hasNext()) {
            // Ancestor is not really an ancestor
            if (!lit.hasNext() || !lit.next().equals(oit.next())) {
                return Optional.empty();
            }

            ++common;
        }

        if (common == 0) {
            return Optional.of(this);
        }
        if (!lit.hasNext()) {
            return Optional.of(empty());
        }

        return Optional.of(createRelativeIdentifier(common));
    }

    @Override
    public final boolean contains(final YangInstanceIdentifier other) {
        if (this == other) {
            return true;
        }

        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;
    }

    @Override
    public final int hashCode() {
        /*
         * The caching is safe, since the object contract requires
         * immutability of the object and all objects referenced from this
         * object.
         * Used lists, maps are immutable. Path Arguments (elements) are also
         * immutable, since the PathArgument contract requires immutability.
         */
        return hash;
    }

    private static int hashCode(final Object value) {
        if (value == null) {
            return 0;
        }

        if (byte[].class.equals(value.getClass())) {
            return Arrays.hashCode((byte[]) value);
        }

        if (value.getClass().isArray()) {
            int hash = 0;
            int length = Array.getLength(value);
            for (int i = 0; i < length; i++) {
                hash += Objects.hashCode(Array.get(value, i));
            }

            return hash;
        }

        return Objects.hashCode(value);
    }

    final Object writeReplace() {
        return new YIDv1(this);
    }

    // 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
     * @return Instance Identifier with only one path argument of type {@link NodeIdentifier}
     */
    public static @NonNull YangInstanceIdentifier of(final QName name) {
        return create(new NodeIdentifier(name));
    }

    /**
     * Returns new builder for InstanceIdentifier with empty path arguments.
     *
     * @return new builder for InstanceIdentifier with empty path arguments.
     */
    public static @NonNull InstanceIdentifierBuilder builder() {
        return new YangInstanceIdentifierBuilder();
    }

    /**
     * Returns new builder for InstanceIdentifier with path arguments copied from original instance identifier.
     *
     * @param origin InstanceIdentifier from which path arguments are copied.
     * @return new builder for InstanceIdentifier with path arguments copied from original instance identifier.
     */
    public static @NonNull InstanceIdentifierBuilder builder(final YangInstanceIdentifier origin) {
        return new YangInstanceIdentifierBuilder(origin.getPathArguments(), origin.hashCode());
    }

    /**
     * Path argument / component of InstanceIdentifier.
     * Path argument uniquely identifies node in data tree on particular
     * level.
     *
     * 

     * This interface itself is used as common parent for actual
     * path arguments types and should not be implemented by user code.
     *
     * 

     * Path arguments SHOULD contain only minimum of information
     * required to uniquely identify node on particular subtree level.
     *
     * 

     * For actual path arguments types see:
     * 
    
     * 
  • {@link NodeIdentifier} - Identifier of container or leaf
     * 
  • {@link NodeIdentifierWithPredicates} - Identifier of list entries, which have key defined
     * 
  • {@link AugmentationIdentifier} - Identifier of augmentation
     * 
  • {@link NodeWithValue} - Identifier of leaf-list entry
     * 

     */
    public interface PathArgument extends Comparable, Immutable, Serializable {
        /**
         * If applicable returns unique QName of data node as defined in YANG
         * Schema.
         *
         * 

         * This method may return null, if the corresponding schema node, does
         * not have QName associated, such as in cases of augmentations.
         *
         * @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
         */
        @NonNull String toRelativeString(PathArgument previous);
    }

    private abstract static class AbstractPathArgument implements PathArgument {
        private static final long serialVersionUID = -4546547994250849340L;
        private final @NonNull QName nodeType;
        private transient volatile int hashValue;

        protected AbstractPathArgument(final QName nodeType) {
            this.nodeType = requireNonNull(nodeType);
        }

        @Override
        public final @NonNull QName getNodeType() {
            return nodeType;
        }

        @Override
        @SuppressWarnings("checkstyle:parameterName")
        public int compareTo(final PathArgument o) {
            return nodeType.compareTo(o.getNodeType());
        }

        protected int hashCodeImpl() {
            return 31 + getNodeType().hashCode();
        }

        @Override
        public final int hashCode() {
            int local;
            return (local = hashValue) != 0 ? local : (hashValue = hashCodeImpl());
        }

        @Override
        public boolean equals(final Object obj) {
            if (this == obj) {
                return true;
            }
            if (obj == null || this.getClass() != obj.getClass()) {
                return false;
            }

            return getNodeType().equals(((AbstractPathArgument)obj).getNodeType());
        }

        @Override
        public String toString() {
            return getNodeType().toString();
        }

        @Override
        public String toRelativeString(final PathArgument previous) {
            if (previous instanceof AbstractPathArgument) {
                final QNameModule mod = previous.getNodeType().getModule();
                if (getNodeType().getModule().equals(mod)) {
                    return getNodeType().getLocalName();
                }
            }

            return getNodeType().toString();
        }

        abstract Object writeReplace();
    }

    /**
     * Simple path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.ContainerNode} or
     * {@link org.opendaylight.yangtools.yang.data.api.schema.LeafNode} leaf in particular subtree.
     */
    public static final class NodeIdentifier extends AbstractPathArgument {
        private static final long serialVersionUID = -2255888212390871347L;
        private static final LoadingCache CACHE = CacheBuilder.newBuilder().weakValues()
                .build(new CacheLoader() {
                    @Override
                    public NodeIdentifier load(final QName key) {
                        return new NodeIdentifier(key);
                    }
                });

        public NodeIdentifier(final QName node) {
            super(node);
        }

        /**
         * Return a NodeIdentifier for a particular QName. Unlike the constructor, this factory method uses a global
         * instance cache, resulting in object reuse for equal inputs.
         *
         * @param node Node's QName
         * @return A {@link NodeIdentifier}
         */
        public static @NonNull NodeIdentifier create(final QName node) {
            return CACHE.getUnchecked(node);
        }

        @Override
        Object writeReplace() {
            return new NIv1(this);
        }
    }

    /**
     * Composite path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode} leaf
     * overall data tree.
     */
    public static final class NodeIdentifierWithPredicates extends AbstractPathArgument {
        private static final long serialVersionUID = -4787195606494761540L;

        private final @NonNull Map keyValues;

        // Exposed for NIPv1
        NodeIdentifierWithPredicates(final Map keyValues, final QName node) {
            super(node);
            this.keyValues = requireNonNull(keyValues);
        }

        public static @NonNull NodeIdentifierWithPredicates of(final QName node) {
            return new NodeIdentifierWithPredicates(node);
        }

        @Deprecated
        public NodeIdentifierWithPredicates(final QName node) {
            super(node);
            this.keyValues = ImmutableMap.of();
        }

        public static @NonNull NodeIdentifierWithPredicates of(final QName node, final Map keyValues) {
            return new NodeIdentifierWithPredicates(node, keyValues);
        }

        @Deprecated
        public NodeIdentifierWithPredicates(final QName node, final Map keyValues) {
            super(node);
            // Retains ImmutableMap for empty maps. For larger sizes uses a shared key set.
            this.keyValues = ImmutableOffsetMap.unorderedCopyOf(keyValues);
        }

        public static @NonNull NodeIdentifierWithPredicates of(final QName node,
                final ImmutableOffsetMap keyValues) {
            return new NodeIdentifierWithPredicates(node, keyValues);
        }

        @Deprecated
        public NodeIdentifierWithPredicates(final QName node, final ImmutableOffsetMap keyValues) {
            this(keyValues, node);
        }

        public static @NonNull NodeIdentifierWithPredicates of(final QName node,
                final SharedSingletonMap keyValues) {
            return new NodeIdentifierWithPredicates(node, keyValues);
        }

        @Deprecated
        public NodeIdentifierWithPredicates(final QName node, final SharedSingletonMap keyValues) {
            this(keyValues, node);
        }

        public static @NonNull NodeIdentifierWithPredicates of(final QName node, final QName key, final Object value) {
            return of(node, SharedSingletonMap.unorderedOf(key, value));
        }

        @Deprecated
        public NodeIdentifierWithPredicates(final QName node, final QName key, final Object value) {
            this(node, SharedSingletonMap.unorderedOf(key, value));
        }

        /**
         * Return predicates as a Map.
         *
         * @return Predicate map.
         * @deprecated Map view is actively discouraged and should be considered deprecated. For replacement, please
         *             see {@link #keySet()}, #entrySet()}, {@link #values()} and {@link #size()}. As a last resort,
         *             please migrate to {@link #asMap()}.
         */
        @Deprecated
        public @NonNull Map getKeyValues() {
            return keyValues;
        }

        /**
         * Return the set of predicates keys and values. Keys are guaranteeed to be unique.
         *
         * @return Predicate set.
         */
        @Beta
        public @NonNull Set> entrySet() {
            return keyValues.entrySet();
        }

        /**
         * Return the predicate key in the iteration order of {@link #entrySet()}.
         *
         * @return Predicate values.
         */
        @Beta
        public @NonNull Set keySet() {
            return keyValues.keySet();
        }

        /**
         * Determine whether a particular predicate key is present.
         *
         * @param key Predicate key
         * @return True if the predicate is present, false otherwise
         * @throws NullPointerException if {@code key} is null
         */
        @Beta
        public boolean containsKey(final QName key) {
            return keyValues.containsKey(requireNonNull(key));
        }

        /**
         * Return the predicate values in the iteration order of {@link #entrySet()}.
         *
         * @return Predicate values.
         */
        @Beta
        public @NonNull Collection values() {
            return keyValues.values();
        }

        @Beta
        public @Nullable Object getValue(final QName key) {
            return keyValues.get(requireNonNull(key));
        }

        @Beta
        public  @Nullable T getValue(final QName key, final Class valueClass) {
            return valueClass.cast(getValue(key));
        }

        /**
         * Return the number of predicates present.
         *
         * @return Thee number of predicates present.
         */
        @Beta
        public int size() {
            return keyValues.size();
        }

        /**
         * A Map-like view of this identifier's predicates. While this method is deprecated, it is preferred to
         * {@link #getKeyValues()}. The view is expected to be stable and effectively-immutable.
         *
         * @return Map of predicates.
         * @deprecated This method in a provisional one. It can be used in the code base, but users requiring it should
         *             contact yangtools-dev for migration
         *             guidelines. Callers are strongly encouraged to explore {@link #entrySet()}, {@link #size()},
         *             {@link #values()} and {@link #keySet()} as an alternative.
         */
        @Beta
        @Deprecated
        // FIXME: 4.0.0: evaluate the real usefulness of this. The problem here is Map.hashCode() and Map.equals(),
        //               which limits our options.
        public @NonNull Map asMap() {
            return keyValues;
        }

        @Override
        protected int hashCodeImpl() {
            final int prime = 31;
            int result = super.hashCodeImpl();
            result = prime * result;

            for (Entry entry : keyValues.entrySet()) {
                // FIXME: 4.0.0: key and value expected to be non-null here
                result += Objects.hashCode(entry.getKey()) + YangInstanceIdentifier.hashCode(entry.getValue());
            }
            return result;
        }

        @Override
        @SuppressWarnings("checkstyle:equalsHashCode")
        public boolean equals(final Object obj) {
            if (!super.equals(obj)) {
                return false;
            }

            final Map 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;
            }

            for (Entry entry : keyValues.entrySet()) {
                if (!otherKeyValues.containsKey(entry.getKey())
                        || !Objects.deepEquals(entry.getValue(), otherKeyValues.get(entry.getKey()))) {

                    return false;
                }
            }

            return true;
        }

        @Override
        public String toString() {
            return super.toString() + '[' + keyValues + ']';
        }

        @Override
        public String toRelativeString(final PathArgument previous) {
            return super.toRelativeString(previous) + '[' + keyValues + ']';
        }

        @Override
        Object writeReplace() {
            return new NIPv1(this);
        }
    }

    /**
     * Simple path argument identifying a {@link LeafSetEntryNode} leaf
     * overall data tree.
     */
    public static final class NodeWithValue extends AbstractPathArgument {
        private static final long serialVersionUID = -3637456085341738431L;

        private final T value;

        public NodeWithValue(final QName node, final T value) {
            super(node);
            this.value = value;
        }

        public T getValue() {
            return value;
        }

        @Override
        protected int hashCodeImpl() {
            final int prime = 31;
            int result = super.hashCodeImpl();
            result = prime * result + YangInstanceIdentifier.hashCode(value);
            return result;
        }

        @Override
        @SuppressWarnings("checkstyle:equalsHashCode")
        public boolean equals(final Object obj) {
            if (!super.equals(obj)) {
                return false;
            }
            final NodeWithValue other = (NodeWithValue) obj;
            return Objects.deepEquals(value, other.value);
        }

        @Override
        public String toString() {
            return super.toString() + '[' + value + ']';
        }

        @Override
        public String toRelativeString(final PathArgument previous) {
            return super.toRelativeString(previous) + '[' + value + ']';
        }

        @Override
        Object writeReplace() {
            return new NIVv1(this);
        }
    }

    /**
     * Composite path argument identifying a {@link org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode}
     * node in particular subtree.
     *
     * 

     * Augmentation is uniquely identified by set of all possible child nodes.
     * This is possible
     * to identify instance of augmentation,
     * since RFC6020 states that augment that augment
     * statement must not add multiple nodes from same namespace
     * / module to the target node.
     *
     * @see RFC6020
     */
    public static final class AugmentationIdentifier implements PathArgument {
        private static final long serialVersionUID = -8122335594681936939L;

        private static final LoadingCache, AugmentationIdentifier> CACHE = CacheBuilder.newBuilder()
                .weakValues().build(new CacheLoader, AugmentationIdentifier>() {
                    @Override
                    public AugmentationIdentifier load(final ImmutableSet key) {
                        return new AugmentationIdentifier(key);
                    }
                });

        private final @NonNull ImmutableSet childNames;

        @Override
        public QName getNodeType() {
            // This should rather throw exception than return always null
            throw new UnsupportedOperationException("Augmentation node has no QName");
        }

        /**
         * Construct new augmentation identifier using supplied set of possible
         * child nodes.
         *
         * @param childNames
         *            Set of possible child nodes.
         */
        public AugmentationIdentifier(final ImmutableSet childNames) {
            this.childNames = requireNonNull(childNames);
        }

        /**
         * Construct new augmentation identifier using supplied set of possible
         * child nodes.
         *
         * @param childNames
         *            Set of possible child nodes.
         */
        public AugmentationIdentifier(final Set childNames) {
            this.childNames = ImmutableSet.copyOf(childNames);
        }

        /**
         * Return an AugmentationIdentifier for a particular set of QNames. Unlike the constructor, this factory method
         * uses a global instance cache, resulting in object reuse for equal inputs.
         *
         * @param childNames Set of possible child nodes
         * @return An {@link AugmentationIdentifier}
         */
        public static @NonNull AugmentationIdentifier create(final ImmutableSet childNames) {
            return CACHE.getUnchecked(childNames);
        }

        /**
         * Return an AugmentationIdentifier for a particular set of QNames. Unlike the constructor, this factory method
         * uses a global instance cache, resulting in object reuse for equal inputs.
         *
         * @param childNames Set of possible child nodes
         * @return An {@link AugmentationIdentifier}
         */
        public static @NonNull AugmentationIdentifier create(final Set childNames) {
            final AugmentationIdentifier existing = CACHE.getIfPresent(childNames);
            return existing != null ? existing : create(ImmutableSet.copyOf(childNames));
        }

        /**
         * Returns set of all possible child nodes.
         *
         * @return set of all possible child nodes.
         */
        public @NonNull Set getPossibleChildNames() {
            return childNames;
        }

        @Override
        public String toString() {
            return "AugmentationIdentifier{" + "childNames=" + childNames + '}';
        }

        @Override
        public String toRelativeString(final PathArgument previous) {
            return toString();
        }

        @Override
        public boolean equals(final Object obj) {
            if (this == obj) {
                return true;
            }
            if (!(obj instanceof AugmentationIdentifier)) {
                return false;
            }

            AugmentationIdentifier that = (AugmentationIdentifier) obj;
            return childNames.equals(that.childNames);
        }

        @Override
        public int hashCode() {
            return childNames.hashCode();
        }

        @Override
        @SuppressWarnings("checkstyle:parameterName")
        public int compareTo(final PathArgument o) {
            if (!(o instanceof AugmentationIdentifier)) {
                return -1;
            }
            AugmentationIdentifier other = (AugmentationIdentifier) o;
            Set otherChildNames = other.getPossibleChildNames();
            int thisSize = childNames.size();
            int otherSize = otherChildNames.size();
            if (thisSize == otherSize) {
                // Quick Set-based comparison
                if (childNames.equals(otherChildNames)) {
                    return 0;
                }

                // We already know the sets are not equal, but have equal size, hence the sets differ in their elements,
                // but potentially share a common set of elements. The most consistent way of comparing them is using
                // total ordering defined by QName's compareTo. Hence convert both sets to lists ordered
                // by QName.compareTo() and decide on the first differing element.
                final List diff = new ArrayList<>(Sets.symmetricDifference(childNames, otherChildNames));
                verify(!diff.isEmpty(), "Augmentation identifiers %s and %s report no difference", this, o);
                diff.sort(QName::compareTo);
                return childNames.contains(diff.get(0)) ? -1 : 1;
            } else if (thisSize < otherSize) {
                return 1;
            } else {
                return -1;
            }
        }

        private Object writeReplace() {
            return new AIv1(this);
        }
    }

    /**
     * Fluent Builder of Instance Identifier instances.
     */
    public interface InstanceIdentifierBuilder extends Builder {
        /**
         * Adds a {@link PathArgument} to path arguments of resulting instance identifier.
         *
         * @param arg A {@link PathArgument} to be added
         * @return this builder
         */
        @NonNull InstanceIdentifierBuilder node(PathArgument arg);

        /**
         * Adds {@link NodeIdentifier} with supplied QName to path arguments of resulting instance identifier.
         *
         * @param nodeType QName of {@link NodeIdentifier} which will be added
         * @return this builder
         */
        @NonNull InstanceIdentifierBuilder node(QName nodeType);

        /**
         * Adds {@link NodeIdentifierWithPredicates} with supplied QName and key values to path arguments of resulting
         * instance identifier.
         *
         * @param nodeType QName of {@link NodeIdentifierWithPredicates} which will be added
         * @param keyValues Map of key components and their respective values for {@link NodeIdentifierWithPredicates}
         * @return this builder
         */
        @NonNull InstanceIdentifierBuilder nodeWithKey(QName nodeType, Map keyValues);

        /**
         * Adds {@link NodeIdentifierWithPredicates} with supplied QName and key, value.
         *
         * @param nodeType QName of {@link NodeIdentifierWithPredicates} which will be added
         * @param key QName of key which will be added
         * @param value value of key which will be added
         * @return this builder
         */
        @NonNull InstanceIdentifierBuilder nodeWithKey(QName nodeType, QName key, Object value);

        /**
         * Adds a collection of {@link PathArgument}s to path arguments of resulting instance identifier.
         *
         * @param args {@link PathArgument}s to be added
         * @return this builder
         * @throws NullPointerException if any of the arguments is null
         */
        @Beta
        @NonNull InstanceIdentifierBuilder append(Collection args);

        /**
         * Adds a collection of {@link PathArgument}s to path arguments of resulting instance identifier.
         *
         * @param args {@link PathArgument}s to be added
         * @return this builder
         * @throws NullPointerException if any of the arguments is null
         */
        @Beta
        default @NonNull InstanceIdentifierBuilder append(final PathArgument... args) {
            return append(Arrays.asList(args));
        }

        /**
         * Builds an {@link YangInstanceIdentifier} with path arguments from this builder.
         *
         * @return {@link YangInstanceIdentifier}
         */
        @Override
        YangInstanceIdentifier build();
    }
}
    

    

    
            
    
            







    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy