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