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

Interface DocumentationGroup

All Known Subinterfaces:

ActionStatement, AnydataStatement, AnyxmlStatement, BitStatement, CaseStatement, ChoiceStatement, ContainerStatement, DataDefinitionStatement, DocumentationGroup.WithStatus, DocumentedConstraintGroup, EnumStatement, ExtensionStatement, FeatureStatement, GroupingStatement, IdentityStatement, ImportStatement, IncludeStatement, LeafListStatement, LeafStatement, LengthStatement, ListStatement, MetaGroup, ModuleStatement, MustStatement, NotificationStatement, OperationGroup, PatternStatement, RangeStatement, RefineStatement, RefineStatement.RefineContainerStatement, RefineStatement.RefineLeafStatement, RevisionStatement, RpcStatement, SubmoduleStatement, TypedefStatement, UsesStatement, WhenStatement

All Known Implementing Classes:

AbstractRootStatement, ActionStatementImpl, AnydataStatementImpl, AnyxmlStatementImpl, BitStatementImpl, CaseStatementImpl, ChoiceStatementImpl, ContainerStatementImpl, EnumStatementImpl, ExtensionStatementImpl, FeatureStatementImpl, GroupingStatementImpl, IdentityStatementImpl, ImportStatementImpl, IncludeStatementImpl, LeafListStatementImpl, LeafStatementImpl, LengthStatementImpl, ListStatementImpl, ModuleStatementImpl, MustStatementImpl, NotificationStatementImpl, PatternStatementImpl, RangeStatementImpl, RefineStatementImpl, RevisionStatementImpl, RpcStatementImpl, SubmoduleStatementImpl, TypedefStatementImpl, UsesStatementImpl, WhenStatementImpl

public interface DocumentationGroup

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentationGroup.WithStatus

Method Summary

Modifier and Type	Method and Description
default DescriptionStatement	getDescription() All implementations should override this method.
default ReferenceStatement	getReference() All implementations should override this method.

Method Detail

getDescription

@Nullable
default DescriptionStatement getDescription()

All implementations should override this method. The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of ImportStatement and IncludeStatement which do not allow a description statement. These YANG statements have been changed in YANG 1.1 (RFC7950) and can now contain a description statement.

Returns:

description statement

getReference

@Nullable
default ReferenceStatement getReference()

All implementations should override this method. The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of ImportStatement and IncludeStatement which do not allow a reference statement. These YANG statements have been changed in YANG 1.1 (RFC7950) and can now contain a reference statement.

Returns:

reference statement