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 org.eclipse.jdt.annotation.NonNull;
15 import org.eclipse.jdt.annotation.Nullable;
16 import org.opendaylight.yangtools.concepts.Immutable;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.common.QNameModule;
19 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
20 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
21 import org.opendaylight.yangtools.yang.model.api.SchemaNodeDefaults;
22 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
23 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
24 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
27 * Effective view of a {@link StmtContext} for the purposes of creating an {@link EffectiveStatement}.
30 public interface EffectiveStmtCtx extends CommonStmtCtx, StmtContextCompat, Immutable {
32 * Return parent of this context, if there is one. All statements except for top-level source statements, such as
33 * {@code module} and {@code submodule}.
35 * @return Parent context, or null if this statement is the root
37 @Nullable Parent effectiveParent();
40 * Return parent of this context.
42 * @return Parent context
43 * @throws VerifyException if this context is already the root
45 default @NonNull Parent getEffectiveParent() {
46 return verifyNotNull(effectiveParent(), "Attempted to access beyond root context");
50 * Minimum amount of parent state required to build an accurate effective view of a particular child. Child state
51 * is expressed as {@link Current}.
54 interface Parent extends EffectiveStmtCtx {
56 * Effective {@code config} statement value.
59 enum EffectiveConfig {
61 * We have an effective {@code config true} statement.
65 * We have an effective {@code config false} statement.
69 * We are in a context where {@code config} statements are ignored.
73 * We are in a context where {@code config} is not determined, such as within a {@code grouping}.
77 private final Boolean config;
79 EffectiveConfig(final @Nullable Boolean config) {
84 * Return this value as a {@link Boolean} for use with {@link DataSchemaNode#effectiveConfig()}.
86 * @return A boolean or null
88 public @Nullable Boolean asNullable() {
94 * Return the effective {@code config} statement value.
96 * @return This statement's effective config
98 @NonNull EffectiveConfig effectiveConfig();
100 // FIXME: 7.0.0: this is currently only used by AbstractTypeStatement
101 @NonNull QNameModule effectiveNamespace();
104 * Return the effective path of this statement. This method is intended for use with statements which naturally
105 * have a {@link QName} identifier and this identifier forms the ultimate step in their
106 * {@link SchemaNode#getPath()}.
109 * Returned object conforms to {@link SchemaPathSupport}'s view of how these are to be handled. Users of this
110 * method are expected to consult {@link SchemaNodeDefaults#extractQName(Immutable)} and
111 * {@link SchemaNodeDefaults#extractPath(Object, Immutable)} to ensure correct implementation behaviour with
112 * respect to {@link SchemaNode#getQName()} and {@link SchemaNode#getPath()} respectively.
114 * @return An {@link Immutable} effective path object
116 // FIXME: Remove this when SchemaNode.getPath() is removed. QName users will store getArgument() instead.
117 default @NonNull Immutable effectivePath() {
118 return SchemaPathSupport.toEffectivePath(getSchemaPath());
122 * Return an optional-to-provide path for {@link SchemaNode#getPath()}. The result of this method is expected
123 * to be consulted with {@link SchemaNodeDefaults#throwUnsupportedIfNull(Object, SchemaPath)} to get consistent
126 * @return Potentially-null {@link SchemaPath}.
128 // FIXME: Remove this when SchemaNode.getPath() is removed
129 default @Nullable SchemaPath optionalPath() {
130 return SchemaPathSupport.toOptionalPath(getSchemaPath());
134 * Return the {@link SchemaNode#getPath()} of this statement. Not all statements have a SchemaPath, in which
135 * case null is returned.
137 * @return SchemaPath or null
139 // FIXME: Remove this when SchemaNode.getPath() is removed
140 @Nullable SchemaPath schemaPath();
143 * Return the {@link SchemaNode#getPath()} of this statement, failing if it is not present.
145 * @return A SchemaPath.
146 * @throws VerifyException if {@link #schemaPath()} returns null
148 // FIXME: Remove this when SchemaNode.getPath() is removed
149 default @NonNull SchemaPath getSchemaPath() {
150 return verifyNotNull(schemaPath(), "Missing path for %s", this);
155 * Minimum amount of state required to build an accurate effective view of a statement. This is a strict superset
156 * of information available in {@link Parent}.
158 * @param <A> Argument type
159 * @param <D> Class representing declared version of this statement
162 interface Current<A, D extends DeclaredStatement<A>> extends Parent, NamespaceStmtCtx, BoundStmtCtxCompat<A, D> {
164 @NonNull QName moduleName();
166 @Nullable EffectiveStatement<?, ?> original();
168 default <T> @Nullable T original(final @NonNull Class<T> type) {
169 return type.cast(original());
172 // FIXME: 7.0.0: this method should be moved to stmt.type in some shape or form
173 @NonNull QName argumentAsTypeQName();
176 * Summon the <a href="https://en.wikipedia.org/wiki/Rabbit_of_Caerbannog">Rabbit of Caerbannog</a>.
178 * @param <E> Effective Statement representation
179 * @return The {@code Legendary Black Beast of Arrrghhh}.
181 // FIXME: YANGTOOLS-1186: lob the Holy Hand Grenade of Antioch
183 <E extends EffectiveStatement<A, D>> @NonNull StmtContext<A, D, E> caerbannog();
186 * Compare another context for equality of {@code getEffectiveParent().getSchemaPath()}, just in a safer manner.
188 * @param other Other {@link Current}
189 * @return True if {@code other} has parent path equal to this context's parent path.
191 // FIXME: Remove this when SchemaNode.getPath() is removed
192 default boolean equalParentPath(final Current<A, D> other) {
193 final Parent ours = effectiveParent();
194 final Parent theirs = other.effectiveParent();
195 return ours == theirs
196 || ours != null && theirs != null && SchemaPathSupport.effectivelyEqual(
197 ours.schemaPath(), theirs.schemaPath());