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

Class StatementSourceReference

java.lang.Object
org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference
All Implemented Interfaces:
Immutable
Direct Known Subclasses:
ExplicitStatement, ImplicitSubstatement
public abstract class StatementSourceReference extends Object implements Immutable
Reference of statement source. Statement source reference serves to provide information, why a statement was defined and introduced in model.

Reasons for introduction of statement could be various, but most obvious one is explicit declaration in model source text such as ExplicitStatement.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StatementSourceReference()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract @Nullable org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference
    declarationReference()
    Returns the DeclarationReference associated with this reference, if available.
    abstract @NonNull org.opendaylight.yangtools.yang.model.api.meta.StatementOrigin
    statementOrigin()
    Returns the StatementOrigin associated with this reference.
    abstract @NonNull 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

    • StatementSourceReference

      public StatementSourceReference()

  • Method Details

    • statementOrigin

      public abstract @NonNull org.opendaylight.yangtools.yang.model.api.meta.StatementOrigin statementOrigin()
      Returns the StatementOrigin associated with this reference.
      Returns:
      StatementOrigin.DECLARATION if statement was explicitly declared in YANG model source, StatementOrigin.CONTEXT if statement was inferred.

    • declarationReference

      public abstract @Nullable org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference declarationReference()
      Returns the DeclarationReference associated with this reference, if available.
      Returns:
      A DeclarationReference or null.

    • toString

      public abstract @NonNull String toString()
      Returns human readable representation of statement source.

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

      Overrides:
      toString in class Object
      Returns:
      human readable representation of statement source.