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

Interface StatementDefinition

All Superinterfaces:

Immutable, MutationBehaviour<Immutable>

All Known Subinterfaces:

StatementSupport<A,D,E>

All Known Implementing Classes:

AbstractQNameStatementSupport, AbstractStatementSupport, ActionStatementSupport, AnnotationStatementSupport, AnydataStatementSupport, AnyxmlSchemaLocationStatementSupport, AnyxmlStatementSupport, AnyxmlStatementSupportOverride, ArgumentStatementSupport, AugmentStatementRFC6020Support, AugmentStatementRFC7950Support, BaseStatementSupport, BelongsToStatementSupport, BitStatementRFC6020Support, BitStatementRFC7950Support, CaseStatementRFC6020Support, CaseStatementRFC7950Support, ChoiceStatementRFC6020Support, ChoiceStatementRFC7950Support, ConfigStatementSupport, ContactStatementSupport, ContainerStatementRFC6020Support, ContainerStatementRFC7950Support, DefaultDenyAllStatementSupport, DefaultDenyWriteStatementSupport, DefaultStatementDefinition, DefaultStatementSupport, DescriptionStatementSupport, DeviateStatementRFC6020Support, DeviateStatementRFC7950Support, DeviationStatementSupport, EncryptedValueStatementSupport, EnumStatementRFC6020Support, EnumStatementRFC7950Support, ErrorAppTagStatementSupport, ErrorMessageStatementSupport, ExtensionStatementSupport, FeatureStatementSupport, ForwardingStatementSupport, FractionDigitsStatementSupport, GroupingStatementRFC6020Support, GroupingStatementRFC7950Support, HashedValueStatementSupport, IdentityStatementRFC6020Support, IdentityStatementRFC7950Support, IfFeatureStatementSupport, ImportStatementRFC6020Support, ImportStatementRFC7950Support, IncludeStatementRFC6020Support, IncludeStatementRFC7950Support, InputStatementRFC6020Support, InputStatementRFC7950Support, KeyStatementSupport, LeafListStatementRFC6020Support, LeafListStatementRFC7950Support, LeafStatementSupport, LengthStatementSupport, ListStatementRFC6020Support, ListStatementRFC7950Support, MandatoryStatementSupport, MaxElementsStatementSupport, MetadataStatements, MinElementsStatementSupport, ModifierStatementSupport, ModuleStatementRFC6020Support, ModuleStatementRFC7950Support, MustStatementSupport, NACMStatements, NamespaceStatementSupport, NotificationStatementRFC6020Support, NotificationStatementRFC7950Support, OpenConfigStatements, OpenConfigVersionSupport, OpenDaylightExtensionsStatements, OrderedByStatementSupport, OrganizationStatementSupport, OutputStatementRFC6020Support, OutputStatementRFC7950Support, PathStatementSupport, PatternStatementRFC6020Support, PatternStatementRFC7950Support, PositionStatementSupport, PrefixStatementSupport, PresenceStatementSupport, RangeStatementSupport, ReferenceStatementSupport, RefineStatementRFC6020Support, RefineStatementRFC7950Support, RequireInstanceStatementSupport, RevisionDateStatementSupport, RevisionStatementSupport, RpcStatementRFC6020Support, RpcStatementRFC7950Support, StatusStatementSupport, SubmoduleStatementRFC6020Support, SubmoduleStatementRFC7950Support, TypedefStatementSupport, TypeStatementRFC6020Support, TypeStatementRFC7950Support, UniqueStatementSupport, UnitsStatementSupport, UsesStatementSupport, ValueStatementSupport, WhenStatementSupport, YangDataStatements, YangDataStatementSupport, YangStmtMapping, YangVersionStatementSupport, YinElementStatementSupport

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 Summary

Modifier and Type	Method and Description
@Nullable QName	getArgumentName() Returns name of statement argument or null, if statement does not have argument.
@NonNull Class<? extends DeclaredStatement<?>>	getDeclaredRepresentationClass() Returns class which represents declared version of statement associated with this definition.
@NonNull Class<? extends EffectiveStatement<?,?>>	getEffectiveRepresentationClass() Returns class which represents derived behaviour from supplied statement.
@NonNull QName	getStatementName() Returns name of the statement.
boolean	isArgumentYinElement() Returns true, if argument of statement is represented as value of yin element.

Method Detail

getStatementName

@NonNull QName getStatementName()

Returns name of the statement.

Returns:

Name of the statement

getArgumentName

@Nullable QName getArgumentName()

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

isArgumentYinElement

boolean isArgumentYinElement()

Returns true, if argument of statement is represented as value of yin element. If argument of statement is represented as argument of yin element, returns false. If this statement does not have an argument, this method returns false.

Returns:

returns true, if statement argument is represented as value of yin element, otherwise returns false.