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

Interface StatementDefinition

All Superinterfaces:
Immutable
All Known Implementing Classes:
AbstractStatementDefinition, DefaultStatementDefinition, IetfYangSmiv2ExtensionsMapping, MetadataStatements, ModuleTagStatements, NACMStatements, NetconfStatements, OpenConfigStatements, OpenDaylightExtensionsStatements, SchemaMountStatements, SubscribedNotificationsStatements, YangDataStatements, YangStmtMapping
public interface StatementDefinition extends Immutable
Definition / model of YANG DeclaredStatement and EffectiveStatement.

Statement concept is defined in RFC6020 section 6.3:

A YANG module contains a sequence of statements. Each statement starts with a keyword, followed by zero or one argument

Source:

  • Method Details

    • getStatementName

      @NonNull QName getStatementName()
      Returns name of the statement.
      Returns:
      Name of the statement

    • getArgumentDefinition

      @NonNull Optional<ArgumentDefinition> getArgumentDefinition()
      Returns name of statement argument or null, if statement does not have argument.
      Returns:
      argument name or null, if statement does not take argument.

    • getDeclaredRepresentationClass

      @NonNull Class<? extends DeclaredStatement<?>> getDeclaredRepresentationClass()
      Returns class which represents declared version of statement associated with this definition. This class should be an interface which provides convenience access to declared substatements.
      Returns:
      class which represents declared version of statement associated with this definition.

    • getEffectiveRepresentationClass

      @NonNull Class<? extends EffectiveStatement<?,?>> getEffectiveRepresentationClass()
      Returns class which represents derived behaviour from supplied statement. This class should be an interface which defines convenience access to statement properties, namespace items and substatements.
      Returns:
      class which represents effective version of statement associated with this definition