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

Interface StatementDefinition

All Superinterfaces:

Immutable, MutationBehaviour<Immutable>

All Known Implementing Classes:

AbstractBooleanStatementSupport, AbstractEmptyStatementSupport, AbstractInternedStatementSupport, AbstractInternedStringStatementSupport, AbstractQNameStatementSupport, AbstractSchemaTreeStatementSupport, AbstractStatementDefinition, AbstractStatementSupport, AbstractStringStatementSupport, ActionStatementSupport, AliasStatementSupport, AnnotationStatementSupport, AnydataStatementSupport, AnyxmlStatementSupport, ArgumentStatementSupport, AugmentIdentifierStatementSupport, AugmentStatementRFC6020Support, AugmentStatementRFC7950Support, BaseStatementSupport, BelongsToStatementSupport, BitStatementSupport, CaseStatementSupport, ChoiceStatementSupport, ConfigStatementSupport, ContactStatementSupport, ContainerStatementSupport, ContextInstanceStatementSupport, ContextReferenceStatementSupport, DefaultDenyAllStatementSupport, DefaultDenyWriteStatementSupport, DefaultStatementDefinition, DefaultStatementSupport, DefValStatementSupport, DescriptionStatementSupport, DeviateStatementRFC6020Support, DeviateStatementRFC7950Support, DeviationStatementSupport, DisplayHintStatementSupport, EncryptedValueStatementSupport, EnumStatementSupport, ErrorAppTagStatementSupport, ErrorMessageStatementSupport, ExtensionStatementSupport, FeatureStatementSupport, ForwardingStatementSupport, FractionDigitsStatementSupport, GetFilterElementAttributesStatementSupport, GroupingStatementSupport, HashedValueStatementSupport, IdentityStatementSupport, IetfYangSmiv2ExtensionsMapping, IfFeatureStatementRFC6020Support, IfFeatureStatementRFC7950Support, ImpliedStatementSupport, ImportStatementSupport, IncludeStatementSupport, InputStatementSupport, InstanceTargetStatementSupport, KeyStatementSupport, LeafListStatementSupport, LeafStatementSupport, LengthStatementSupport, ListStatementSupport, MandatoryStatementSupport, MaxAccessStatementSupport, MaxElementsStatementSupport, MetadataStatements, MinElementsStatementSupport, ModifierStatementSupport, ModuleStatementSupport, MountPointStatementSupport, MountStatementSupport, MustStatementSupport, NACMStatements, NamespaceStatementSupport, NetconfStatements, NotificationStatementRFC6020Support, NotificationStatementRFC7950Support, OidStatementSupport, OpenConfigStatements, OpenConfigVersionSupport, OpenDaylightExtensionsStatements, OrderedByStatementSupport, OrganizationStatementSupport, OutputStatementSupport, PathStatementSupport, PatternStatementSupport, PositionStatementSupport, PrefixStatementSupport, PresenceStatementSupport, RangeStatementSupport, ReferenceStatementSupport, RefineStatementSupport, RequireInstanceStatementSupport, RevisionDateStatementSupport, RevisionStatementSupport, RpcContextReferenceStatementSupport, RpcStatementSupport, SchemaMountStatements, StatementSupport, StatusStatementSupport, SubIdStatementSupport, SubmoduleStatementSupport, SubscribedNotificationsStatements, SubscriptionStateNotificationStatementSupport, 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	Description
@NonNull Optional<ArgumentDefinition>	getArgumentDefinition()	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.

Method Detail

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