yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/EffectiveStmtCtx.java

   1 /*
   2  * Copyright (c) 2020 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.parser.spi.meta;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.VerifyException;
  14 import java.util.Map;
  15 import java.util.Optional;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.eclipse.jdt.annotation.Nullable;
  18 import org.opendaylight.yangtools.concepts.Immutable;
  19 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  23
  24 /**
  25  * Effective view of a {@link StmtContext} for the purposes of creating an {@link EffectiveStatement}.
  26  */
  27 @Beta
  28 public interface EffectiveStmtCtx extends CommonStmtCtx, StmtContextCompat, Immutable {
  29     /**
  30      * Return parent of this context, if there is one. All statements except for top-level source statements, such as
  31      * {@code module} and {@code submodule}.
  32      *
  33      * @return Parent context, or null if this statement is the root
  34      */
  35     @Nullable Parent effectiveParent();
  36
  37     /**
  38      * Return parent of this context.
  39      *
  40      * @return Parent context
  41      * @throws VerifyException if this context is already the root
  42      */
  43     default @NonNull Parent getEffectiveParent() {
  44         return verifyNotNull(effectiveParent(), "Attempted to access beyond root context");
  45     }
  46
  47     /**
  48      * Minimum amount of parent state required to build an accurate effective view of a particular child. Child state
  49      * is expressed as {@link Current}.
  50      */
  51     @Beta
  52     interface Parent extends EffectiveStmtCtx {
  53         // FIXME: 7.0.0: this should be Optional<Boolean>
  54         boolean effectiveConfig();
  55
  56         /**
  57          * Return the {@link SchemaPath} of this statement. Not all statements have a SchemaPath, in which case
  58          * {@link Optional#empty()} is returned.
  59          *
  60          * @return Optional SchemaPath
  61          * @deprecated Use of SchemaPath in the context of effective statements is going away. Consider not providing
  62          *             this information, if your users can exist without it.
  63          */
  64         // FIXME: 7.0.0: this needs to be a tri-state present/absent/disabled
  65         @Deprecated
  66         @NonNull Optional<SchemaPath> schemaPath();
  67
  68         @Deprecated
  69         default @NonNull SchemaPath getSchemaPath() {
  70             return schemaPath().orElseThrow();
  71         }
  72     }
  73
  74     /**
  75      * Minimum amount of state required to build an accurate effective view of a statement. This is a strict superset
  76      * of information available in {@link Parent}.
  77      *
  78      * @param <A> Argument type
  79      * @param <D> Class representing declared version of this statement
  80      */
  81     @Beta
  82     interface Current<A, D extends DeclaredStatement<A>> extends Parent, BoundStmtCtx<A> {
  83
  84         @NonNull CommonStmtCtx root();
  85
  86         @NonNull D declared();
  87
  88         <K, V, T extends K, N extends IdentifierNamespace<K, V>> @Nullable V getFromNamespace(Class<@NonNull N> type,
  89             T key);
  90
  91         <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromCurrentStmtCtxNamespace(Class<N> type);
  92
  93         @Nullable EffectiveStatement<?, ?> original();
  94
  95         /**
  96          * Summon the <a href="https://en.wikipedia.org/wiki/Rabbit_of_Caerbannog">Rabbit of Caerbannog</a>.
  97          *
  98          * @param <E> Effective Statement representation
  99          * @return The {@code Legendary Black Beast of Arrrghhh}.
 100          */
 101         // FIXME: YANGTOOLS-1186: lob the Holy Hand Grenade of Antioch
 102         @Deprecated
 103         <E extends EffectiveStatement<A, D>> @NonNull StmtContext<A, D, E> caerbannog();
 104     }
 105 }