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.controller.md.sal.dom.store.impl.tree;
10 import java.util.AbstractMap.SimpleEntry;
11 import java.util.ArrayList;
12 import java.util.Iterator;
13 import java.util.List;
16 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
17 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
19 import com.google.common.base.Optional;
20 import com.google.common.base.Preconditions;
21 import com.google.common.base.Predicate;
22 import com.google.common.base.Predicates;
25 * A set of utility methods for interacting with {@link org.opendaylight.controller.md.sal.dom.store.impl.tree.spi.TreeNode} objects.
27 public final class TreeNodeUtils {
28 private TreeNodeUtils() {
29 throw new UnsupportedOperationException("Utility class should not be instantiated");
33 * Finds a node in tree
35 * @param tree Data Tree
36 * @param path Path to the node
37 * @return Optional with node if the node is present in tree, {@link Optional#absent()} otherwise.
39 public static <T extends StoreTreeNode<T>> Optional<T> findNode(final T tree, final InstanceIdentifier path) {
40 Optional<T> current = Optional.<T> of(tree);
41 Iterator<PathArgument> pathIter = path.getPath().iterator();
42 while (current.isPresent() && pathIter.hasNext()) {
43 current = current.get().getChild(pathIter.next());
48 public static <T extends StoreTreeNode<T>> T findNodeChecked(final T tree, final InstanceIdentifier path) {
50 List<PathArgument> nested = new ArrayList<>(path.getPath().size());
51 for(PathArgument pathArg : path.getPath()) {
52 Optional<T> potential = current.getChild(pathArg);
54 Preconditions.checkArgument(potential.isPresent(),"Child %s is not present in tree.",nested);
55 current = potential.get();
61 * Finds a node or closest parent in the tree
63 * @param tree Data Tree
64 * @param path Path to the node
65 * @return Map.Entry Entry with key which is path to closest parent and value is parent node.
68 public static <T extends StoreTreeNode<T>> Map.Entry<InstanceIdentifier, T> findClosest(final T tree, final InstanceIdentifier path) {
69 return findClosestsOrFirstMatch(tree, path, Predicates.<T>alwaysFalse());
72 public static <T extends StoreTreeNode<T>> Map.Entry<InstanceIdentifier, T> findClosestsOrFirstMatch(final T tree, final InstanceIdentifier path, final Predicate<T> predicate) {
73 Optional<T> parent = Optional.<T>of(tree);
74 Optional<T> current = Optional.<T> of(tree);
77 Iterator<PathArgument> pathIter = path.getPath().iterator();
78 while (current.isPresent() && pathIter.hasNext() && !predicate.apply(current.get())) {
80 current = current.get().getChild(pathIter.next());
83 if(current.isPresent()) {
84 final InstanceIdentifier currentPath = new InstanceIdentifier(path.getPath().subList(0, nesting));
85 return new SimpleEntry<InstanceIdentifier,T>(currentPath,current.get());
89 * Subtracting 1 from nesting level at this point is safe, because we
90 * cannot reach here with nesting == 0: that would mean the above check
91 * for current.isPresent() failed, which it cannot, as current is always
92 * present. At any rate we check state just to be on the safe side.
94 Preconditions.checkState(nesting > 0);
95 final InstanceIdentifier parentPath = new InstanceIdentifier(path.getPath().subList(0, nesting - 1));
97 return new SimpleEntry<InstanceIdentifier,T>(parentPath,parent.get());
100 public static <T extends StoreTreeNode<T>> Optional<T> getChild(final Optional<T> parent,final PathArgument child) {
101 if(parent.isPresent()) {
102 return parent.get().getChild(child);
104 return Optional.absent();