/*
* 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
import com.google.common.annotations.Beta;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
-import com.google.common.collect.ImmutableMap;
+import com.google.common.cache.CacheBuilder;
+import com.google.common.cache.CacheLoader;
+import com.google.common.cache.LoadingCache;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import java.io.Serializable;
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;
* which conceptually is XPath expression minimized to uniquely identify element
* in data tree which conforms to constraints maintained by YANG Model,
* effectively this makes Instance Identifier a path to element in data tree.
+ * </p>
* <p>
* Constraints put in YANG specification on instance-identifier allowed it to be
* effectively represented in Java and it's evaluation does not require
* full-blown XPath processor.
- * <p>
+ * </p>
* <h3>Path Arguments</h3>
+ * <p>
* 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.
- * <p>
+ * </p>
* <ul>
* <li>{@link NodeIdentifier} - Identifier of node, which has cardinality
* <code>0..1</code> in particular subtree in data tree.</li>
*
* @see <a href="http://tools.ietf.org/html/rfc6020#section-9.13">RFC6020</a>
*/
-public abstract class YangInstanceIdentifier extends IterablePathArguments implements Path<YangInstanceIdentifier>, Immutable, Serializable {
+public abstract class YangInstanceIdentifier implements Path<YangInstanceIdentifier>, Immutable, Serializable {
/**
* An empty {@link YangInstanceIdentifier}. It corresponds to the path of the conceptual
* root of the YANG namespace.
* Return the conceptual parent {@link YangInstanceIdentifier}, which has
* one item less in {@link #getPathArguments()}.
*
- * @return Parent {@link YangInstanceIdentifier}, or null if this is object is {@link #EMPTY}.
+ * @return Parent {@link YangInstanceIdentifier}, or null if this object is {@link #EMPTY}.
*/
@Nullable public abstract YangInstanceIdentifier getParent();
/**
- * Returns a list of path arguments.
+ * Return the ancestor {@link YangInstanceIdentifier} with a particular depth, e.g. number of path arguments.
*
- * @deprecated Use {@link #getPathArguments()} instead.
- * @return Immutable list 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.
*/
- @Deprecated
- public final List<PathArgument> getPath() {
- return getPathArguments();
- }
+ @Nonnull public abstract YangInstanceIdentifier getAncestor(int depth);
/**
* Returns an ordered iteration of path arguments.
*
* @return Immutable iteration of path arguments.
*/
- @Override
public abstract List<PathArgument> getPathArguments();
/**
*
* @return Immutable iterable of path arguments in reverse order.
*/
- @Override
public abstract List<PathArgument> getReversePathArguments();
/**
private static final long serialVersionUID = -4546547994250849340L;
private final QName nodeType;
private transient int hashValue;
- private volatile transient boolean hashGuard = false;
+ private transient volatile boolean hashGuard = false;
protected AbstractPathArgument(final QName nodeType) {
this.nodeType = Preconditions.checkNotNull(nodeType);
}
}
- /**
- * Fluent Builder of Instance Identifier instances
- */
- public interface InstanceIdentifierBuilder extends Builder<YangInstanceIdentifier> {
- /**
- * Adds a {@link PathArgument} to to path arguments of resulting instance identifier.
- *
- * @param arg A {@link PathArgument} to be added
- * @return this builder
- */
- 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
- */
- 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
- */
- InstanceIdentifierBuilder nodeWithKey(QName nodeType, Map<QName, Object> 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
- */
- InstanceIdentifierBuilder nodeWithKey(QName nodeType, QName key, Object value);
-
- /**
- *
- * Builds an {@link YangInstanceIdentifier} with path arguments from this builder
- *
- * @return {@link YangInstanceIdentifier}
- */
- @Override
- YangInstanceIdentifier build();
-
- /*
- * @deprecated use #build()
- */
- @Deprecated
- YangInstanceIdentifier toInstance();
- }
-
/**
* 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<QName, NodeIdentifier> CACHE = CacheBuilder.newBuilder().weakValues()
+ .build(new CacheLoader<QName, NodeIdentifier>() {
+ @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 NodeIdentifier create(final QName node) {
+ return CACHE.getUnchecked(node);
+ }
}
/**
public NodeIdentifierWithPredicates(final QName node, final Map<QName, Object> keyValues) {
super(node);
- this.keyValues = ImmutableMap.copyOf(keyValues);
+ // Retains ImmutableMap for empty maps. For larger sizes uses a shared key set.
+ this.keyValues = ImmutableOffsetMap.unorderedCopyOf(keyValues);
}
public NodeIdentifierWithPredicates(final QName node, final QName key, final Object value) {
- this(node, ImmutableMap.of(key, value));
+ super(node);
+ this.keyValues = SharedSingletonMap.unorderedOf(key, value);
}
public Map<QName, Object> getKeyValues() {
}
}
}
+
+ /**
+ * Fluent Builder of Instance Identifier instances
+ */
+ public interface InstanceIdentifierBuilder extends Builder<YangInstanceIdentifier> {
+ /**
+ * Adds a {@link PathArgument} to to path arguments of resulting instance identifier.
+ *
+ * @param arg A {@link PathArgument} to be added
+ * @return this builder
+ */
+ 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
+ */
+ 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
+ */
+ InstanceIdentifierBuilder nodeWithKey(QName nodeType, Map<QName, Object> 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
+ */
+ InstanceIdentifierBuilder nodeWithKey(QName nodeType, QName key, Object value);
+
+ /**
+ *
+ * Builds an {@link YangInstanceIdentifier} with path arguments from this builder
+ *
+ * @return {@link YangInstanceIdentifier}
+ */
+ @Override
+ YangInstanceIdentifier build();
+ }
}