2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.yangtools.yang.parser.spi.meta;
10 import static com.google.common.base.Verify.verifyNotNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.base.VerifyException;
14 import java.util.Optional;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.eclipse.jdt.annotation.Nullable;
17 import org.opendaylight.yangtools.concepts.Immutable;
18 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
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;
24 * Effective view of a {@link StmtContext} for the purposes of creating an {@link EffectiveStatement}.
27 public interface EffectiveStmtCtx extends CommonStmtCtx, StmtContextCompat, Immutable {
29 * Return parent of this context, if there is one. All statements except for top-level source statements, such as
30 * {@code module} and {@code submodule}.
32 * @return Parent context, or null if this statement is the root
34 @Nullable Parent effectiveParent();
37 * Return parent of this context.
39 * @return Parent context
40 * @throws VerifyException if this context is already the root
42 default @NonNull Parent getEffectiveParent() {
43 return verifyNotNull(effectiveParent(), "Attempted to access beyond root context");
47 * Minimum amount of parent state required to build an accurate effective view of a particular child. Child state
48 * is expressed as {@link Current}.
51 interface Parent extends EffectiveStmtCtx {
53 * Effective {@code config} statement value.
56 enum EffectiveConfig {
58 * We have an effective {@code config true} statement.
62 * We have an effective {@code config false} statement.
66 * We are in a context where {@code config} statements are ignored.
70 * We are in a context where {@code config} is not determined, such as within a {@code grouping}.
74 private final Boolean config;
76 EffectiveConfig(final @Nullable Boolean config) {
81 * Return this value as a {@link Boolean} for use with {@link DataSchemaNode#effectiveConfig()}.
83 * @return A boolean or null
85 public @Nullable Boolean asNullable() {
91 * Return the effective {@code config} statement value.
93 * @return This statement's effective config
95 @NonNull EffectiveConfig effectiveConfig();
98 * Return the {@link SchemaPath} of this statement. Not all statements have a SchemaPath, in which case
99 * {@link Optional#empty()} is returned.
101 * @return Optional SchemaPath
102 * @deprecated Use of SchemaPath in the context of effective statements is going away. Consider not providing
103 * this information, if your users can exist without it.
105 // FIXME: 7.0.0: this needs to be a tri-state present/absent/disabled
107 @NonNull Optional<SchemaPath> schemaPath();
110 default @NonNull SchemaPath getSchemaPath() {
111 return schemaPath().orElseThrow();
115 default @Nullable SchemaPath wrapSchemaPath() {
116 return SchemaPathSupport.wrap(getSchemaPath());
121 * Minimum amount of state required to build an accurate effective view of a statement. This is a strict superset
122 * of information available in {@link Parent}.
124 * @param <A> Argument type
125 * @param <D> Class representing declared version of this statement
128 interface Current<A, D extends DeclaredStatement<A>> extends Parent, NamespaceStmtCtx, BoundStmtCtxCompat<A, D> {
130 @NonNull CommonStmtCtx root();
132 @Nullable EffectiveStatement<?, ?> original();
135 * Summon the <a href="https://en.wikipedia.org/wiki/Rabbit_of_Caerbannog">Rabbit of Caerbannog</a>.
137 * @param <E> Effective Statement representation
138 * @return The {@code Legendary Black Beast of Arrrghhh}.
140 // FIXME: YANGTOOLS-1186: lob the Holy Hand Grenade of Antioch
142 <E extends EffectiveStatement<A, D>> @NonNull StmtContext<A, D, E> caerbannog();