yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/DataSchemaContextTree.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.data.util;
   9
  10 import com.google.common.cache.CacheBuilder;
  11 import com.google.common.cache.CacheLoader;
  12 import com.google.common.cache.LoadingCache;
  13 import java.util.Optional;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  17 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  18
  19 /**
  20  * Semantic tree binding a {@link EffectiveModelContext} to a {@link NormalizedNode} tree. Since the layout of the
  21  * schema and data has differences, the mapping is not trivial -- which is where this class comes in.
  22  *
  23  * @author Robert Varga
  24  */
  25 public final class DataSchemaContextTree {
  26     private static final LoadingCache<EffectiveModelContext, DataSchemaContextTree> TREES = CacheBuilder.newBuilder()
  27             .weakKeys().weakValues().build(new CacheLoader<EffectiveModelContext, DataSchemaContextTree>() {
  28                 @Override
  29                 public DataSchemaContextTree load(final EffectiveModelContext key) {
  30                     return new DataSchemaContextTree(key);
  31                 }
  32             });
  33
  34     private final DataSchemaContextNode<?> root;
  35
  36     private DataSchemaContextTree(final EffectiveModelContext ctx) {
  37         root = DataSchemaContextNode.from(ctx);
  38     }
  39
  40     public static @NonNull DataSchemaContextTree from(final @NonNull EffectiveModelContext ctx) {
  41         return TREES.getUnchecked(ctx);
  42     }
  43
  44     /**
  45      * Find a child node as identified by an absolute {@link YangInstanceIdentifier}.
  46      *
  47      * @param path Path towards the child node
  48      * @return Child node if present, or empty when corresponding child is not found.
  49      * @throws NullPointerException if {@code path} is null
  50      */
  51     public @NonNull Optional<@NonNull DataSchemaContextNode<?>> findChild(final @NonNull YangInstanceIdentifier path) {
  52         return getRoot().findChild(path);
  53     }
  54
  55     public @NonNull DataSchemaContextNode<?> getRoot() {
  56         return root;
  57     }
  58 }