model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContext.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. 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.model.api;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import java.util.Map;
  15 import java.util.Optional;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.common.QNameModule;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeRoot;
  24
  25 /**
  26  * {@link EffectiveStatement}-based result of YANG parser compilation. Unlike a SchemaContext, which it extends,
  27  * it gives access to individual {@link ModuleEffectiveStatement}s that comprise it. It also supports resolution of
  28  * schema node identifiers via {@link #findSchemaTreeNode(SchemaNodeIdentifier)}.
  29  *
  30  * @author Robert Varga
  31  */
  32 @Beta
  33 // FIXME: 8.0.0: evaluate if we still need to extend SchemaContext here
  34 public interface EffectiveModelContext extends SchemaContext, SchemaTreeRoot {
  35
  36     @NonNull Map<QNameModule, ModuleEffectiveStatement> getModuleStatements();
  37
  38     default @NonNull Optional<ModuleEffectiveStatement> findModuleStatement(final QNameModule moduleName) {
  39         return Optional.ofNullable(getModuleStatements().get(requireNonNull(moduleName)));
  40     }
  41
  42     default @NonNull Optional<ModuleEffectiveStatement> findModuleStatement(final QName moduleName) {
  43         return findModuleStatement(moduleName.getModule());
  44     }
  45
  46     default @NonNull ModuleEffectiveStatement getModuleStatement(final QNameModule moduleName) {
  47         return verifyNotNull(getModuleStatements().get(requireNonNull(moduleName)));
  48     }
  49
  50     default @NonNull ModuleEffectiveStatement getModuleStatement(final QName moduleName) {
  51         return getModuleStatement(moduleName.getModule());
  52     }
  53
  54     /**
  55      * {@inheritDoc}
  56      *
  57      * @implSpec
  58      *     Default implementation defers locates the module corresponding to the first element of path and then defers
  59      *     to {@link ModuleEffectiveStatement#findSchemaTreeNode(SchemaNodeIdentifier)}.
  60      */
  61     @Override
  62     default Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(final SchemaNodeIdentifier path) {
  63         return findModuleStatement(path.firstNodeIdentifier().getModule())
  64             .flatMap(module -> module.findSchemaTreeNode(path));
  65     }
  66 }