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

Interface DocumentedDeclaredStatement<T>

All Superinterfaces:

DeclaredStatement<T>, DocumentationGroup, ModelStatement<T>

All Known Subinterfaces:

ActionStatement, 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, MultipleElementsDeclaredStatement, MustStatement, NotificationStatement, OperationDeclaredStatement, PatternStatement, RangeStatement, RefineStatement, RevisionStatement, RpcStatement, SubmoduleStatement, TypedefStatement, UsesStatement, WhenStatement

All Known Implementing Classes:

AbstractRootStatement, GroupingStatementImpl, PatternStatementImpl

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

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 and Description
static interface	DocumentedDeclaredStatement.WithStatus<T>

Method Summary

Modifier and Type	Method and Description
default DescriptionStatement	getDescription() Return description statement, if available.
default 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 DescriptionStatement getDescription()

Description copied from interface: DocumentationGroup

Return description statement, if available.

Specified by:

getDescription in interface DocumentationGroup

Returns:

description statement

getReference

default ReferenceStatement getReference()

Description copied from interface: DocumentationGroup

Return description statement, if available.

Specified by:

getReference in interface DocumentationGroup

Returns:

description statement