org.opendaylight.yangtools.yang.parser.spi.source

Class DeclarationInTextSource

java.lang.Object

org.opendaylight.yangtools.yang.parser.spi.source.DeclarationInTextSource

All Implemented Interfaces:

StatementSourceReference

public abstract class DeclarationInTextSource
extends Object
implements StatementSourceReference

Reference of statement source present in textual source format. Utility implementation of StatementSourceReference for textual sources, this is prefered StatementSourceReference for implementations of YANG / YIN statement stream sources.

To create source reference use one of this static factories:

• atPosition(String, int, int) - provides most specific reference of statement location, this is most prefered since it provides most context to debug YANG model.
• atLine(String, int)- provides source and line of statement location.
• inSource(String) - least specific reference, should be used only if any of previous references are unable to create / derive from source.

Method Summary

Modifier and Type	Method and Description
static DeclarationInTextSource	atLine(String sourceName, int line)
static DeclarationInTextSource	atPosition(String sourceName, int line, int position)
String	getSourceName()
StatementSource	getStatementSource() Returns source type.
static DeclarationInTextSource	inSource(String sourceName)
abstract String	toString() Returns human readable representation of statement source.

Methods inherited from class java.lang.Object

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

Method Detail

inSource

public static DeclarationInTextSource inSource(String sourceName)

atLine

public static DeclarationInTextSource atLine(String sourceName,
                                             int line)

atPosition

public static DeclarationInTextSource atPosition(String sourceName,
                                                 int line,
                                                 int position)

getSourceName

public String getSourceName()

getStatementSource

public StatementSource getStatementSource()

Description copied from interface: StatementSourceReference

Returns source type.

Specified by:

getStatementSource in interface StatementSourceReference

Returns:

StatementSource.DECLARATION if statement was explicitly declared in YANG model source, StatementSource.CONTEXT if statement was inferred.

toString

public abstract String toString()

Description copied from interface: StatementSourceReference

Returns human readable representation of statement source.

Implementations of this interface should override StatementSourceReference.toString(), since it may be used in error reporting to provide context information for model designer to debug errors in its mode.

Specified by:

toString in interface StatementSourceReference

Overrides:

toString in class Object

Returns:

human readable representation of statement source.