org.opendaylight.yangtools.yang.parser.util

Class ASTSchemaSource

java.lang.Object

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

All Implemented Interfaces:

Identifiable<SourceIdentifier>, Immutable, MutationBehaviour<Immutable>, SchemaSourceRepresentation

@Beta
public final class ASTSchemaSource
extends Object
implements 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 Deprecated.
static com.google.common.base.Function<ASTSchemaSource,YangModelDependencyInfo>	GET_DEPINFO Deprecated.
static com.google.common.base.Function<ASTSchemaSource,SourceIdentifier>	GET_IDENTIFIER Deprecated.
static com.google.common.base.Function<ASTSchemaSource,SourceIdentifier>	GET_SEMVER_IDENTIFIER Deprecated.

Method Summary

Modifier and Type	Method and Description
static ASTSchemaSource	create(SourceIdentifier identifier, 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(SourceIdentifier identifier, org.antlr.v4.runtime.ParserRuleContext tree, String text) Deprecated. Use create(SourceIdentifier, ParserRuleContext) instead.
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 symbolicName, SourceIdentifier identifier, 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.
org.antlr.v4.runtime.ParserRuleContext	getAST() Return the underlying abstract syntax tree.
YangModelDependencyInfo	getDependencyInformation() Return the dependency information as extracted from the AST.
SourceIdentifier	getIdentifier() Return this objects Identifier
SemVerSourceIdentifier	getSemVerIdentifier()
Optional<String>	getSymbolicName() Return the symbolic name, if available.
Class<? extends SchemaSourceRepresentation>	getType() Return the concrete representation type.

Methods inherited from class java.lang.Object

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

Field Detail

GET_IDENTIFIER

@Deprecated
public static final com.google.common.base.Function<ASTSchemaSource,SourceIdentifier> GET_IDENTIFIER

Deprecated.

GET_SEMVER_IDENTIFIER

@Deprecated
public static final com.google.common.base.Function<ASTSchemaSource,SourceIdentifier> GET_SEMVER_IDENTIFIER

Deprecated.

GET_DEPINFO

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

Deprecated.

GET_AST

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

Deprecated.

Method Detail

create

public static ASTSchemaSource create(@Nonnull
                                     String name,
                                     @Nonnull
                                     org.antlr.v4.runtime.ParserRuleContext tree)
                              throws 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:

YangSyntaxErrorException - if we fail to extract dependency information.

create

@Deprecated
public static ASTSchemaSource create(@Nonnull
                                                 SourceIdentifier identifier,
                                                 @Nonnull
                                                 org.antlr.v4.runtime.ParserRuleContext tree,
                                                 String text)
                                          throws YangSyntaxErrorException

Deprecated. Use create(SourceIdentifier, ParserRuleContext) instead.

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

Parameters:

identifier - SourceIdentifier of yang schema source.

tree - ANTLR abstract syntax tree

text - YANG text source

Returns:

A new representation instance.

Throws:

YangSyntaxErrorException - if we fail to extract dependency information.

create

public static ASTSchemaSource create(@Nonnull
                                     SourceIdentifier identifier,
                                     @Nonnull
                                     org.antlr.v4.runtime.ParserRuleContext tree)
                              throws YangSyntaxErrorException

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

Parameters:

identifier - SourceIdentifier of yang schema source.

tree - ANTLR abstract syntax tree

Returns:

A new representation instance.

Throws:

YangSyntaxErrorException - if we fail to extract dependency information.

create

public static ASTSchemaSource create(@Nonnull
                                     String symbolicName,
                                     @Nonnull
                                     SourceIdentifier identifier,
                                     @Nonnull
                                     org.antlr.v4.runtime.ParserRuleContext tree)
                              throws YangSyntaxErrorException

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

Parameters:

symbolicName - Symbolic name

identifier - SourceIdentifier of yang schema source.

tree - ANTLR abstract syntax tree

Returns:

A new representation instance.

Throws:

YangSyntaxErrorException - if we fail to extract dependency information.

getIdentifier

public SourceIdentifier getIdentifier()

Description copied from interface: SchemaSourceRepresentation

Return this objects Identifier

Specified by:

getIdentifier in interface Identifiable<SourceIdentifier>

Specified by:

getIdentifier in interface SchemaSourceRepresentation

Returns:

Object's identifier, must not be null.

getSymbolicName

public Optional<String> getSymbolicName()

Description copied from interface: SchemaSourceRepresentation

Return the symbolic name, if available. This name has no semantic meaning beyond being useful for debugging by humans.

Specified by:

getSymbolicName in interface SchemaSourceRepresentation

Returns:

Symbolic name, if available

getSemVerIdentifier

public SemVerSourceIdentifier getSemVerIdentifier()

getType

@Nonnull
public Class<? extends SchemaSourceRepresentation> getType()

Description copied from interface: SchemaSourceRepresentation

Return the concrete representation type.

Specified by:

getType in interface SchemaSourceRepresentation

Returns:

The type of representation.

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.