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:

AbstractRootStatement

@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

declaredSubstatements, declaredSubstatements, findFirstDeclaredSubstatement, findFirstDeclaredSubstatementArgument, rawArgument, streamDeclaredSubstatements

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

argument, getStatementSource, 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