Package org.opendaylight.yangtools.yang.model.api.meta

Class StatementDeclaration

java.lang.Object

org.opendaylight.yangtools.yang.model.api.meta.StatementSourceReference

org.opendaylight.yangtools.yang.model.api.meta.StatementDeclaration

All Implemented Interfaces:

Immutable, DeclarationReference

Direct Known Subclasses:

StatementDeclaration.InText

@NonNullByDefault
public abstract class StatementDeclaration
extends StatementSourceReference
implements DeclarationReference

A StatementSourceReference which acts as its own DeclarationReference, i.e. referring to a statement source present in textual source format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatementDeclaration.InText	A StatementDeclaration which acts as its own DeclarationInText.
static class	StatementDeclaration.InTextFile	A StatementDeclaration.InText which acts as its own DeclarationInFile.

Constructor Summary

Constructors

Constructor	Description
StatementDeclaration()

Method Summary

Modifier and Type	Method	Description
protected abstract int	column()
final @NonNull DeclarationReference	declarationReference()	Returns the DeclarationReference associated with this reference, if available.
protected abstract @Nullable String	file()
protected abstract int	line()
final StatementOrigin	statementOrigin()	Returns the StatementOrigin associated with this reference.
final String	toHumanReadable()	Returns human readable representation of this reference.
final 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

Constructor Details

StatementDeclaration

public StatementDeclaration()

Method Details

statementOrigin

public final StatementOrigin statementOrigin()

Description copied from class: StatementSourceReference

Returns the StatementOrigin associated with this reference.

Specified by:

statementOrigin in class StatementSourceReference

Returns:

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

declarationReference

public final @NonNull DeclarationReference declarationReference()

Description copied from class: StatementSourceReference

Returns the DeclarationReference associated with this reference, if available.

Specified by:

declarationReference in class StatementSourceReference

Returns:

A DeclarationReference or null.

toHumanReadable

public final String toHumanReadable()

Description copied from interface: DeclarationReference

Returns human readable representation of this reference. This method does not prescribe any format of the returned string.

Specified by:

toHumanReadable in interface DeclarationReference

Returns:

human readable representation of this reference.

toString

public final String toString()

Description copied from class: 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 class StatementSourceReference

Returns:

human readable representation of statement source.

file

protected abstract @Nullable String file()

line

protected abstract int line()

column

protected abstract int column()