org.opendaylight.yangtools.yang.parser.util

Class ASTSchemaSource

java.lang.Object

org.opendaylight.yangtools.yang.parser.util.ASTSchemaSource

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier>, org.opendaylight.yangtools.concepts.Immutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Immutable>, org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation

@Beta
public final class ASTSchemaSource
extends Object
implements org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation

Abstract Syntax Tree representation of a schema source. This representation is internal to the YANG parser implementation, as it relies on ANTLR types. Instances of this representation are used for caching purposes, as they are a natural intermediate step in YANG text processing pipeline: the text has been successfully parsed, so we know it is syntactically correct. It also passes basic semantic validation and we were able to extract dependency information.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<ASTSchemaSource,org.antlr.v4.runtime.ParserRuleContext>	GET_AST
static com.google.common.base.Function<ASTSchemaSource,YangModelDependencyInfo>	GET_DEPINFO
static com.google.common.base.Function<ASTSchemaSource,org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier>	GET_IDENTIFIER

Method Summary

Methods

Modifier and Type	Method and Description
static ASTSchemaSource	create(String name, org.antlr.v4.runtime.ParserRuleContext tree) Create a new instance of AST representation for a abstract syntax tree, performing minimal semantic analysis to acquire dependency information.
static ASTSchemaSource	create(String name, org.antlr.v4.runtime.ParserRuleContext tree, String text) Deprecated. Migration only, will be removed as soon as the migration is completed.
org.antlr.v4.runtime.ParserRuleContext	getAST() Return the underlying abstract syntax tree.
YangModelDependencyInfo	getDependencyInformation() Return the dependency information as extracted from the AST.
org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier	getIdentifier()
Class<? extends org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation>	getType()
String	getYangText() Deprecated. Used for migration purposes. Users are advised to use the schema repository to acquire the representation of their choice. Will be removed as soon as the migration is completed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GET_IDENTIFIER

public static final com.google.common.base.Function<ASTSchemaSource,org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier> GET_IDENTIFIER

GET_DEPINFO

public static final com.google.common.base.Function<ASTSchemaSource,YangModelDependencyInfo> GET_DEPINFO

GET_AST

public static final com.google.common.base.Function<ASTSchemaSource,org.antlr.v4.runtime.ParserRuleContext> GET_AST

Method Detail

create

public static ASTSchemaSource create(@Nonnull
                     String name,
                     @Nonnull
                     org.antlr.v4.runtime.ParserRuleContext tree)
                              throws org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException

Create a new instance of AST representation for a abstract syntax tree, performing minimal semantic analysis to acquire dependency information.

Parameters:

name - YANG source name. Used only for error reporting.

tree - ANTLR abstract syntax tree

Returns:

A new representation instance.

Throws:

org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException - if we fail to extract dependency information.

create

@Deprecated
public static ASTSchemaSource create(@Nonnull
                                String name,
                                @Nonnull
                                org.antlr.v4.runtime.ParserRuleContext tree,
                                String text)
                              throws org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException

Deprecated. Migration only, will be removed as soon as the migration is completed.

Create a new instance of AST representation for a abstract syntax tree, performing minimal semantic analysis to acquire dependency information.

Parameters:

name - YANG source name. Used only for error reporting.

tree - ANTLR abstract syntax tree

Returns:

A new representation instance.

Throws:

org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException - if we fail to extract dependency information.

getIdentifier

public org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier>

Specified by:

getIdentifier in interface org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation

getType

public Class<? extends org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation> getType()

Specified by:

getType in interface org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation

getAST

@Nonnull
public org.antlr.v4.runtime.ParserRuleContext getAST()

Return the underlying abstract syntax tree.

Returns:

Underlying AST.

getDependencyInformation

@Nonnull
public YangModelDependencyInfo getDependencyInformation()

Return the dependency information as extracted from the AST. FIXME: this method should be extracted into a public interface in the model.api.repo class, relying solely on model.api types.

Returns:

Dependency information.

getYangText

@Deprecated
@Nonnull
public String getYangText()

Deprecated. Used for migration purposes. Users are advised to use the schema repository to acquire the representation of their choice. Will be removed as soon as the migration is completed.

Return the semantically-equivalent text YANG text source.

Returns:

YANG text source