+/*
+ * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
package org.opendaylight.yangtools.yang.parser.spi.meta;
+import com.google.common.annotations.Beta;
+import java.util.Optional;
+import javax.annotation.Nullable;
+import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
+import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementDefinitionContext;
/**
- *
* Support for processing concrete YANG statement.
*
+ * <p>
* This interface is intended to be implemented by developers, which want to
* introduce support of statement to parser. Consider subclassing
* {@link AbstractStatementSupport} for easier implementation of this interface.
* @param <E>
* Effective Statement representation
*/
-public interface StatementSupport<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends StatementDefinition, StatementFactory<A, D, E> {
+public interface StatementSupport<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
+ extends StatementDefinition, StatementFactory<A, D, E> {
/**
- * Returns public statement definition, which will be present in builded statements.
+ * Returns public statement definition, which will be present in built
+ * statements.
*
- * Public statement definition may be used to provide different implementation
- * of statement definition, which will not retain any build specific data
- * or context.
+ * Public statement definition may be used to provide different
+ * implementation of statement definition, which will not retain any build
+ * specific data or context.
*
- * @return public statement definition, which will be present in builded statements.
+ * @return public statement definition, which will be present in built
+ * statements.
*/
- StatementDefinition getPublicView();
+ StatementDefinition getPublicView();
/**
- *
* Parses textual representation of argument in object representation.
*
- * @param ctx Context, which may be used to access source-specific namespaces
- * required for parsing.
- * @param value String representation of value, as was present in text source.
+ * @param ctx
+ * Context, which may be used to access source-specific
+ * namespaces required for parsing.
+ * @param value
+ * String representation of value, as was present in text source.
* @return Parsed value
+ * @throws SourceException
+ * when an inconsistency is detected.
*/
- A parseArgumentValue(StmtContext<?, ?, ?> ctx, String value) throws SourceException;
+ A parseArgumentValue(StmtContext<?, ?, ?> ctx, String value);
/**
- *
- * Invoked when statement is added to build context.
+ * Adapts the argument value to match a new module.
+ *
+ * @param ctx
+ * Context, which may be used to access source-specific
+ * namespaces required for parsing.
+ * @param targetModule
+ * Target module, may not be null.
+ * @return Adapted argument value. The default implementation returns original value stored in context.
+ */
+ default A adaptArgumentValue(final StmtContext<A, D, E> ctx, final QNameModule targetModule) {
+ return ctx.getStatementArgument();
+ }
+
+ /**
+ * Invoked when a statement supported by this instance is added to build context. This allows implementations
+ * of this interface to start tracking the statement and perform any modifications to the build context hierarchy,
+ * accessible via {@link StmtContext#getParentContext()}. One such use is populating the parent's namespaces to
+ * allow it to locate this child statement.
*
* @param stmt
- * Context of added statement. No substatement are available.
+ * Context of added statement. No substatements are available.
*/
- void onStatementAdded(StmtContext.Mutable<A, D, E> stmt);
+ void onStatementAdded(StmtContext.Mutable<A, D, E> stmt);
+
+ /**
+ * Returns implicit parent statement support for supplied statement
+ * definition, if it is defined. This allows implementations of this
+ * interface add implicit parent to the build context hierarchy before a
+ * substatement is created.
+ *
+ * @param stmtDef
+ * statement definition of substatement
+ * @return optional of implicit parent statement support
+ */
+ Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef);
/**
- *
- * Invoked when statement is closed during
- * {@link ModelProcessingPhase#STATEMENT_DEFINITION} phase.
- *
* Invoked when statement is closed during
- * {@link ModelProcessingPhase#STATEMENT_DEFINITION} phase, only substatements from
- * this and previous phase are available.
+ * {@link ModelProcessingPhase#SOURCE_PRE_LINKAGE} phase, only substatements
+ * from this and previous phase are available.
*
* Implementation may use method to perform actions on this event or
* register modification action using
* @param stmt
* Context of added statement.
*/
- void onLinkageDeclared(StmtContext.Mutable<A, D, E> stmt) throws SourceException;
+ void onPreLinkageDeclared(StmtContext.Mutable<A, D, E> stmt);
/**
- *
* Invoked when statement is closed during
- * {@link ModelProcessingPhase#STATEMENT_DEFINITION} phase.
+ * {@link ModelProcessingPhase#SOURCE_LINKAGE} phase, only substatements
+ * from this and previous phase are available.
+ *
+ * Implementation may use method to perform actions on this event or
+ * register modification action using
+ * {@link StmtContext.Mutable#newInferenceAction(ModelProcessingPhase)}.
*
+ * @param stmt
+ * Context of added statement.
+ * @throws SourceException
+ * when an inconsistency is detected.
+ */
+ void onLinkageDeclared(StmtContext.Mutable<A, D, E> stmt);
+
+ /**
* Invoked when statement is closed during
- * {@link ModelProcessingPhase#STATEMENT_DEFINITION} phase, only substatements from
- * this phase are available.
+ * {@link ModelProcessingPhase#STATEMENT_DEFINITION} phase, only
+ * substatements from this phase are available.
*
* Implementation may use method to perform actions on this event or
* register modification action using
* @param stmt
* Context of added statement. Argument and statement parent is
* accessible.
+ * @throws SourceException
+ * when an inconsistency is detected.
*/
- void onStatementDefinitionDeclared(StmtContext.Mutable<A, D, E> stmt) throws SourceException;
+ void onStatementDefinitionDeclared(StmtContext.Mutable<A, D, E> stmt);
/**
- *
* Invoked when statement is closed during
* {@link ModelProcessingPhase#FULL_DECLARATION} phase.
*
* @param stmt
* Context of added statement. Argument and statement parent is
* accessible.
+ * @throws SourceException
+ * when an inconsistency is detected.
+ */
+ void onFullDefinitionDeclared(StmtContext.Mutable<A, D, E> stmt);
+
+ /**
+ * Returns true if this support has argument specific supports.
+ */
+ boolean hasArgumentSpecificSupports();
+
+ /**
+ * If this support has argument specific supports, the method returns
+ * support specific for given argument (e.g. type statement support need to
+ * be specialized based on its argument), otherwise returns null.
+ *
+ * @param argument
+ * argument of statement
+ * @return statement support specific for supplied argument or null
+ */
+ @Nullable
+ StatementSupport<?, ?, ?> getSupportSpecificForArgument(String argument);
+
+ /**
+ * Given a raw string representation of an argument, try to use a shared representation
+ *
+ * @param rawArgument
+ * Argument string
+ * @return A potentially-shard instance
+ */
+ default String internArgument(final String rawArgument) {
+ return rawArgument;
+ }
+
+ /**
+ * Returns unknown statement form of a regular yang statement supplied as
+ * parameter to the method.
+ *
+ * @param yangStmtDef
+ * statement definition of a regular yang statement
+ * @return Optional of unknown statement form of a regular yang statement or
+ * Optional.empty() if it is not supported by this statement support
+ */
+ default Optional<StatementDefinitionContext<?, ?, ?>> getUnknownStatementDefinitionOf(
+ final StatementDefinitionContext<?, ?, ?> yangStmtDef) {
+ return Optional.empty();
+ }
+
+ /**
+ * Returns true if this statement support and all its substatements ignore
+ * if-feature statements (e.g. yang-data extension defined in
+ * https://tools.ietf.org/html/rfc8040#section-8). Default implementation
+ * returns false.
+ *
+ * @return true if this statement support ignores if-feature statements,
+ * otherwise false.
*/
- void onFullDefinitionDeclared(StmtContext.Mutable<A, D, E> stmt) throws SourceException;
+ @Beta
+ default boolean isIgnoringIfFeatures() {
+ return false;
+ }
-}
\ No newline at end of file
+ /**
+ * Returns true if this statement support and all its substatements ignore
+ * config statements (e.g. yang-data extension defined in
+ * https://tools.ietf.org/html/rfc8040#section-8). Default implementation
+ * returns false.
+ *
+ * @return true if this statement support ignores config statements,
+ * otherwise false.
+ */
+ @Beta
+ default boolean isIgnoringConfig() {
+ return false;
+ }
+}
Code Review / yangtools.git / blobdiff