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

Interface DocumentedDeclaredStatement<T>

All Superinterfaces:

DeclaredStatement<T>, ModelStatement<T>

All Known Subinterfaces:

ActionStatement, AliasStatement, AnnotationStatement, AnydataStatement, AnyxmlStatement, AugmentStatement, BitStatement, CaseStatement, ChoiceStatement, ConstrainedDocumentedDeclaredStatement<T>, ConstrainedDocumentedDeclaredStatement.WithStatus<T>, ContainerStatement, DataDefinitionStatement, DeviationStatement, DocumentedDeclaredStatement.WithStatus<T>, EnumStatement, ExtensionStatement, FeatureStatement, GroupingStatement, IdentityStatement, ImportStatement, IncludeStatement, LeafListStatement, LeafStatement, LengthStatement, ListStatement, MetaDeclaredStatement<T>, ModuleStatement, MountPointStatement, MultipleElementsDeclaredStatement, MustStatement, NotificationStatement, OperationDeclaredStatement, PatternStatement, RangeStatement, RefineStatement, RevisionStatement, RpcStatement, SubmoduleStatement, TypedefStatement, UsesStatement, WhenStatement

All Known Implementing Classes:

DeviationStatementImpl, EmptyActionStatement, EmptyAnydataStatement, EmptyAnyxmlStatement, EmptyAugmentStatement, EmptyBitStatement, EmptyCaseStatement, EmptyChoiceStatement, EmptyContainerStatement, EmptyEnumStatement, EmptyExtensionStatement, EmptyFeatureStatement, EmptyGroupingStatement, EmptyIdentityStatement, EmptyIncludeStatement, EmptyLeafListStatement, EmptyLeafStatement, EmptyLengthStatement, EmptyListStatement, EmptyMustStatement, EmptyNotificationStatement, EmptyPatternStatement, EmptyRangeStatement, EmptyRevisionStatement, EmptyRpcStatement, EmptyTypedefStatement, EmptyUsesStatement, EmptyWhenStatement, ImportStatementImpl, ModuleStatementImpl, RefActionStatement, RefAnydataStatement, RefAnyxmlStatement, RefAugmentStatement, RefBitStatement, RefCaseStatement, RefChoiceStatement, RefContainerStatement, RefDeviationStatement, RefEnumStatement, RefExtensionStatement, RefFeatureStatement, RefGroupingStatement, RefIdentityStatement, RefImportStatement, RefIncludeStatement, RefineStatementImpl, RefLeafListStatement, RefLeafStatement, RefLengthStatement, RefListStatement, RefModuleStatement, RefMustStatement, RefNotificationStatement, RefPatternStatement, RefRangeStatement, RefRefineStatement, RefRevisionStatement, RefRpcStatement, RefSubmoduleStatement, RefTypedefStatement, RefUsesStatement, RefWhenStatement, RegularActionStatement, RegularAnydataStatement, RegularAnyxmlStatement, RegularAugmentStatement, RegularBitStatement, RegularCaseStatement, RegularChoiceStatement, RegularContainerStatement, RegularEnumStatement, RegularExtensionStatement, RegularFeatureStatement, RegularGroupingStatement, RegularIdentityStatement, RegularIncludeStatement, RegularLeafListStatement, RegularLeafStatement, RegularLengthStatement, RegularListStatement, RegularMustStatement, RegularNotificationStatement, RegularPatternStatement, RegularRangeStatement, RegularRevisionStatement, RegularRpcStatement, RegularTypedefStatement, RegularUsesStatement, RegularWhenStatement, SubmoduleStatementImpl

@Beta
public interface DocumentedDeclaredStatement<T>
extends DeclaredStatement<T>

Common interface for statements which contain either a description/reference or a description/reference/status combo.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DocumentedDeclaredStatement.WithStatus<T>

Method Summary

Modifier and Type	Method	Description
default @NonNull Optional<DescriptionStatement>	getDescription()	Return description statement, if available.
default @NonNull Optional<ReferenceStatement>	getReference()	Return description statement, if available.

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement

declarationReference, declaredSubstatements, declaredSubstatements, findFirstDeclaredSubstatement, findFirstDeclaredSubstatementArgument, rawArgument, streamDeclaredSubstatements

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.ModelStatement

argument, statementDefinition

Method Detail

getDescription

default @NonNull Optional<DescriptionStatement> getDescription()

Return description statement, if available.

Returns:

description statement

getReference

default @NonNull Optional<ReferenceStatement> getReference()

Return description statement, if available.

Returns:

description statement