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

Interface EffectiveStatementMixins.DocumentedNodeMixin<A,D extends DeclaredStatement<A>>

Type Parameters:

A - Argument type (Void if statement does not have argument.)

D - Class representing declared version of this statement.

All Superinterfaces:

DocumentedNode, EffectiveStatement<A,D>, ModelStatement<A>

All Known Subinterfaces:

EffectiveStatementMixins.ConstraintMetaDefinitionMixin<A,D>, EffectiveStatementMixins.DataSchemaNodeMixin<A,D>, EffectiveStatementMixins.DocumentedNodeMixin.WithStatus<A,D>, EffectiveStatementMixins.OpaqueDataSchemaNodeMixin<D>, EffectiveStatementMixins.OperationContainerMixin<D>, EffectiveStatementMixins.OperationDefinitionMixin<D>, EffectiveStatementMixins.SchemaNodeMixin<A,D>, EffectiveStatementMixins.UnknownSchemaNodeMixin<A,D>

All Known Implementing Classes:

AbstractEffectiveDocumentedNodeWithStatus, AbstractEffectiveModule, AbstractLeafEffectiveStatement, ActionEffectiveStatementImpl, AugmentEffectiveStatementImpl, ChoiceEffectiveStatementImpl, ContainerEffectiveStatementImpl, DeclaredCaseEffectiveStatement, DeclaredInputEffectiveStatement, DeclaredOutputEffectiveStatement, DeviationEffectiveStatementImpl, EmptyAnydataEffectiveStatement, EmptyAnyxmlEffectiveStatement, EmptyBitEffectiveStatement, EmptyEnumEffectiveStatement, EmptyFeatureEffectiveStatement, EmptyIdentityEffectiveStatement, EmptyLeafEffectiveStatement, EmptyLengthEffectiveStatement, EmptyMustEffectiveStatement, EmptyPatternEffectiveStatement, EmptyRangeEffectiveStatement, EmptyRevisionEffectiveStatement, ExtensionEffectiveStatementImpl, GroupingEffectiveStatementImpl, ImportEffectiveStatementImpl, NotificationEffectiveStatementImpl, RefineEffectiveStatementImpl, RegularAnydataEffectiveStatement, RegularAnyxmlEffectiveStatement, RegularBitEffectiveStatement, RegularEnumEffectiveStatement, RegularFeatureEffectiveStatement, RegularIdentityEffectiveStatement, RegularLeafEffectiveStatement, RegularLengthEffectiveStatement, RegularMustEffectiveStatement, RegularPatternEffectiveStatement, RegularRangeEffectiveStatement, RegularRevisionEffectiveStatement, RpcEffectiveStatementImpl, TypedefEffectiveStatementImpl, UndeclaredCaseEffectiveStatement, UndeclaredInputEffectiveStatement, UndeclaredOutputEffectiveStatement, UnknownEffectiveStatementBase

Enclosing class:

EffectiveStatementMixins

public static interface EffectiveStatementMixins.DocumentedNodeMixin<A,D extends DeclaredStatement<A>>
extends DocumentedNode

Bridge between EffectiveStatementMixins.EffectiveStatementWithFlags and DocumentedNode.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EffectiveStatementMixins.DocumentedNodeMixin.WithStatus<A,D extends DeclaredStatement<A>>	Bridge between EffectiveStatementMixins.EffectiveStatementWithFlags and DocumentedNode.WithStatus.

Method Summary

Modifier and Type	Method	Description
default Optional<String>	getDescription()	Returns the value of the argument of YANG description keyword.
default Optional<String>	getReference()	Returns the value of the argument of YANG reference keyword.
default Collection<? extends UnknownSchemaNode>	getUnknownSchemaNodes()	Returns unknown schema nodes which belongs to this instance.

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

effectiveSubstatements, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, get, getAll, getDeclared, streamEffectiveSubstatements

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

argument, statementDefinition, statementOrigin

Method Detail

getDescription

default Optional<String> getDescription()

Description copied from interface: DocumentedNode

Returns the value of the argument of YANG description keyword.

Specified by:

getDescription in interface DocumentedNode

Returns:

string with the description, or empty if description was not provided.

getReference

default Optional<String> getReference()

Description copied from interface: DocumentedNode

Returns the value of the argument of YANG reference keyword.

Specified by:

getReference in interface DocumentedNode

Returns:

string with reference to some other document, or empty if reference was not provided.

getUnknownSchemaNodes

default Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes()

Description copied from interface: DocumentedNode

Returns unknown schema nodes which belongs to this instance. Default implementation returns an empty collection.

Specified by:

getUnknownSchemaNodes in interface DocumentedNode

Returns:

collection of unknown schema nodes defined under this node.