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

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

Type Parameters:

A - Argument type (Empty 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<D>, EffectiveStatementMixins.DocumentedNodeMixin.WithStatus<A,D>, EffectiveStatementMixins.OpaqueDataSchemaNodeMixin<D>, EffectiveStatementMixins.OperationContainerMixin<D>, EffectiveStatementMixins.OperationDefinitionMixin<D>, EffectiveStatementMixins.SchemaNodeMixin<D>, EffectiveStatementMixins.UnknownSchemaNodeMixin<A,D>

All Known Implementing Classes:

AbstractChoiceEffectiveStatement, AbstractContainerEffectiveStatement, AbstractEffectiveModule, AbstractEffectiveUnknownSchmemaNode, AbstractGroupingEffectiveStatement, AbstractLeafEffectiveStatement, ActionEffectiveStatementImpl, AugmentEffectiveStatementImpl, DeclaredCaseEffectiveStatement, DeclaredInputEffectiveStatement, DeclaredOutputEffectiveStatement, DeviationEffectiveStatementImpl, EmptyAnydataEffectiveStatement, EmptyAnyxmlEffectiveStatement, EmptyBitEffectiveStatement, EmptyChoiceEffectiveStatement, EmptyContainerEffectiveStatement, EmptyEnumEffectiveStatement, EmptyFeatureEffectiveStatement, EmptyGroupingEffectiveStatement, EmptyIdentityEffectiveStatement, EmptyLeafEffectiveStatement, EmptyLeafListEffectiveStatement, EmptyLengthEffectiveStatement, EmptyListEffectiveStatement, EmptyMustEffectiveStatement, EmptyPatternEffectiveStatement, EmptyRangeEffectiveStatement, EmptyRevisionEffectiveStatement, ExtensionEffectiveStatementImpl, ImportEffectiveStatementImpl, NotificationEffectiveStatementImpl, RefineEffectiveStatementImpl, RegularAnydataEffectiveStatement, RegularAnyxmlEffectiveStatement, RegularBitEffectiveStatement, RegularChoiceEffectiveStatement, RegularContainerEffectiveStatement, RegularEnumEffectiveStatement, RegularFeatureEffectiveStatement, RegularGroupingEffectiveStatement, RegularIdentityEffectiveStatement, RegularLeafEffectiveStatement, RegularLeafListEffectiveStatement, RegularLengthEffectiveStatement, RegularListEffectiveStatement, RegularMustEffectiveStatement, RegularPatternEffectiveStatement, RegularRangeEffectiveStatement, RegularRevisionEffectiveStatement, RpcEffectiveStatementImpl, SlimLeafListEffectiveStatement, TypedefEffectiveStatementImpl, UndeclaredCaseEffectiveStatement, UndeclaredInputEffectiveStatement, UndeclaredLeafEffectiveStatement, UndeclaredOutputEffectiveStatement

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 <T> @NonNull Collection<? extends @NonNull T>	filterEffectiveStatements(Class<T> type)
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, statementOrigin, streamEffectiveSubstatements

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

argument, statementDefinition

Method Details

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.

filterEffectiveStatements

default <T>
@NonNull Collection<? extends @NonNull T> filterEffectiveStatements(Class<T> type)