2 * Copyright (c) 2013 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.model.api;
10 import com.google.common.base.MoreObjects;
11 import com.google.common.base.MoreObjects.ToStringHelper;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.ImmutableList;
14 import com.google.common.collect.Iterables;
15 import com.google.common.collect.Lists;
16 import com.google.common.collect.UnmodifiableIterator;
17 import java.util.ArrayList;
18 import java.util.Arrays;
19 import java.util.Iterator;
20 import java.util.List;
21 import java.util.NoSuchElementException;
22 import java.util.Objects;
23 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
24 import org.opendaylight.yangtools.concepts.Immutable;
25 import org.opendaylight.yangtools.yang.common.QName;
28 * Represents unique path to the every node inside the module.
30 public abstract class SchemaPath implements Immutable {
33 * An absolute SchemaPath.
35 private static final class AbsoluteSchemaPath extends SchemaPath {
36 private AbsoluteSchemaPath(final SchemaPath parent, final QName qname) {
41 public boolean isAbsolute() {
46 protected SchemaPath createInstance(final SchemaPath parent, final QName qname) {
47 return new AbsoluteSchemaPath(parent, Preconditions.checkNotNull(qname));
52 * A relative SchemaPath.
54 private static final class RelativeSchemaPath extends SchemaPath {
55 private RelativeSchemaPath(final SchemaPath parent, final QName qname) {
60 public boolean isAbsolute() {
65 protected SchemaPath createInstance(final SchemaPath parent, final QName qname) {
66 return new RelativeSchemaPath(parent, Preconditions.checkNotNull(qname));
70 @SuppressWarnings("rawtypes")
71 private static final AtomicReferenceFieldUpdater<SchemaPath, ImmutableList> LEGACYPATH_UPDATER =
72 AtomicReferenceFieldUpdater.newUpdater(SchemaPath.class, ImmutableList.class, "legacyPath");
75 * Shared instance of the conceptual root schema node.
77 public static final SchemaPath ROOT = new AbsoluteSchemaPath(null, null);
80 * Shared instance of the "same" relative schema node.
82 public static final SchemaPath SAME = new RelativeSchemaPath(null, null);
87 private final SchemaPath parent;
92 private final QName qname;
95 * Cached hash code. We can use this since we are immutable.
97 private final int hash;
100 * Cached legacy path, filled-in when {@link #getPath()} or {@link #getPathTowardsRoot()}
103 private volatile ImmutableList<QName> legacyPath;
106 * @deprecated This constructor will be hidden in a future release.
111 protected SchemaPath(final SchemaPath parent, final QName qname) {
112 this.parent = parent;
115 int h = Objects.hashCode(parent);
117 h = h * 31 + qname.hashCode();
123 private ImmutableList<QName> getLegacyPath() {
124 ImmutableList<QName> ret = legacyPath;
126 final List<QName> tmp = new ArrayList<>();
127 for (QName qname : getPathTowardsRoot()) {
130 ret = ImmutableList.copyOf(Lists.reverse(tmp));
131 LEGACYPATH_UPDATER.lazySet(this, ret);
138 * Returns the complete path to schema node.
140 * @return list of <code>QName</code> instances which represents complete
141 * path to schema node
143 * @deprecated Use {@link #getPathFromRoot()} instead.
146 public List<QName> getPath() {
147 return getLegacyPath();
151 * Constructs new instance of this class with the concrete path.
154 * list of QName instances which specifies exact path to the
157 * boolean value which specifies if the path is absolute or
160 * @return A SchemaPath instance.
162 public static SchemaPath create(final Iterable<QName> path, final boolean absolute) {
163 final SchemaPath parent = absolute ? ROOT : SAME;
164 return parent.createChild(path);
168 * Constructs new instance of this class with the concrete path.
171 * boolean value which specifies if the path is absolute or
174 * one or more QName instances which specifies exact path to the
177 * @return A SchemaPath instance.
179 public static SchemaPath create(final boolean absolute, final QName... path) {
180 return create(Arrays.asList(path), absolute);
184 * Create a new instance.
186 * @param parent Parent SchemaPath
187 * @param qname next path element
188 * @return A new SchemaPath instance
190 protected abstract SchemaPath createInstance(SchemaPath parent, QName qname);
193 * Create a child path based on concatenation of this path and a relative path.
195 * @param relative Relative path
196 * @return A new child path
198 public SchemaPath createChild(final Iterable<QName> relative) {
199 if (Iterables.isEmpty(relative)) {
203 SchemaPath parentPath = this;
204 for (QName qname : relative) {
205 parentPath = parentPath.createInstance(parentPath, qname);
212 * Create a child path based on concatenation of this path and a relative path.
214 * @param relative Relative SchemaPath
215 * @return A new child path
217 public SchemaPath createChild(final SchemaPath relative) {
218 Preconditions.checkArgument(!relative.isAbsolute(), "Child creation requires relative path");
220 SchemaPath parentPath = this;
221 for (QName qname : relative.getPathFromRoot()) {
222 parentPath = parentPath.createInstance(parentPath, qname);
229 * Create a child path based on concatenation of this path and additional
232 * @param elements Relative SchemaPath elements
233 * @return A new child path
235 public SchemaPath createChild(final QName... elements) {
236 return createChild(Arrays.asList(elements));
240 * Returns the list of nodes which need to be traversed to get from the
241 * starting point (root for absolute SchemaPaths) to the node represented
244 * @return list of <code>qname</code> instances which represents
245 * path from the root to the schema node.
247 public Iterable<QName> getPathFromRoot() {
248 return getLegacyPath();
252 * Returns the list of nodes which need to be traversed to get from this
253 * node to the starting point (root for absolute SchemaPaths).
255 * @return list of <code>qname</code> instances which represents
256 * path from the schema node towards the root.
258 public Iterable<QName> getPathTowardsRoot() {
259 return new Iterable<QName>() {
261 public Iterator<QName> iterator() {
262 return new UnmodifiableIterator<QName>() {
263 private SchemaPath current = SchemaPath.this;
266 public boolean hasNext() {
267 return current.parent != null;
271 public QName next() {
272 if (current.parent != null) {
273 final QName ret = current.qname;
274 current = current.parent;
277 throw new NoSuchElementException("No more elements available");
286 * Returns the immediate parent SchemaPath.
288 * @return Parent path, null if this SchemaPath is already toplevel.
290 public SchemaPath getParent() {
295 * Get the last component of this path.
297 * @return The last component of this path.
299 public final QName getLastComponent() {
304 * Describes whether schema path is|isn't absolute.
306 * @return boolean value which is <code>true</code> if schema path is
309 public abstract boolean isAbsolute();
312 public final int hashCode() {
317 public boolean equals(final Object obj) {
324 if (getClass() != obj.getClass()) {
327 final SchemaPath other = (SchemaPath) obj;
328 return Objects.equals(qname, other.qname) && Objects.equals(parent, other.parent);
332 public final String toString() {
333 return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
336 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
337 return toStringHelper.add("path", getPathFromRoot());