Package org.opendaylight.yangtools.yang.model.api

Interface DocumentedNode

All Known Subinterfaces:

ActionDefinition, AnnotationSchemaNode, AnnotationSchemaNodeAwareSchemaContext, AnydataSchemaNode, AnyxmlSchemaNode, AugmentationSchemaNode, BinaryTypeDefinition, BitsTypeDefinition, BitsTypeDefinition.Bit, BooleanTypeDefinition, CaseSchemaNode, ChoiceSchemaNode, ConstraintMetaDefinition, ContainerSchemaNode, DataSchemaNode, DecimalTypeDefinition, DefaultDenyAllSchemaNode, DefaultDenyWriteSchemaNode, DerivableSchemaNode, Deviation, DocumentedNode.WithStatus, EffectiveModelContext, EffectiveStatementMixins.DataSchemaNodeMixin<A,D>, EffectiveStatementMixins.DocumentedNodeMixin<A,D>, EffectiveStatementMixins.DocumentedNodeMixin.WithStatus<A,D>, EffectiveStatementMixins.SchemaNodeMixin<A,D>, EmptyTypeDefinition, EnumTypeDefinition, EnumTypeDefinition.EnumPair, ExtensionDefinition, FeatureDefinition, GetFilterElementAttributesSchemaNode, GroupingDefinition, IdentityrefTypeDefinition, IdentitySchemaNode, IdentityTypeDefinition, InstanceIdentifierTypeDefinition, Int16TypeDefinition, Int32TypeDefinition, Int64TypeDefinition, Int8TypeDefinition, LeafListSchemaNode, LeafrefTypeDefinition, LeafSchemaNode, LengthConstraint, LengthRestrictedTypeDefinition<T>, ListSchemaNode, Module, ModuleImport, MountPointSchemaNode, MustDefinition, NotificationDefinition, OpenConfigHashedValueSchemaNode, OperationDefinition, PatternConstraint, RangeConstraint<T>, RangeRestrictedTypeDefinition<T,N>, RequireInstanceRestrictedTypeDefinition<T>, RpcDefinition, SchemaContext, SchemaNode, StringTypeDefinition, TypedDataSchemaNode, TypeDefinition<T>, Uint16TypeDefinition, Uint32TypeDefinition, Uint64TypeDefinition, Uint8TypeDefinition, UnionTypeDefinition, UnknownSchemaNode, UnknownTypeDefinition, UsesNode, YangDataSchemaNode, YangModeledAnyxmlSchemaNode

All Known Implementing Classes:

AbstractConstraintEffectiveStatement, AbstractEffectiveContainerSchemaNode, AbstractEffectiveDataSchemaNode, AbstractEffectiveDocumentedDataNodeContainer, AbstractEffectiveDocumentedNode, AbstractEffectiveDocumentedNodeWithoutStatus, AbstractEffectiveModule, AbstractEffectiveMustConstraintAwareDataSchemaNode, AbstractEffectiveMustConstraintAwareSimpleDataNodeContainer, AbstractEffectiveOperationContainerSchemaNode, AbstractEffectiveOperationDefinition, AbstractEffectiveSchemaNode, AbstractEffectiveSimpleDataNodeContainer, AbstractListConstraintEffectiveStatement, AbstractSchemaContext, AbstractSchemaEffectiveDocumentedNode, AnyxmlSchemaLocationEffectiveStatementImpl, BitEffectiveStatementImpl, EffectiveAugmentationSchema, EffectiveSchemaContext, EnumEffectiveStatementImpl, FilteringSchemaContextProxy, LengthEffectiveStatementImpl, OperationAsContainer, RangeEffectiveStatementImpl, RefineEffectiveStatementImpl, SimpleSchemaContext, UnknownEffectiveStatementBase

public interface DocumentedNode

Node which can have documentation assigned.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DocumentedNode.WithStatus

Method Summary

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

Method Detail

getDescription

Optional<String> getDescription()

Returns the value of the argument of YANG description keyword.

Returns:

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

getReference

Optional<String> getReference()

Returns the value of the argument of YANG reference keyword.

Returns:

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

getUnknownSchemaNodes

default @NonNull List<UnknownSchemaNode> getUnknownSchemaNodes()

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

Returns:

list of unknown schema nodes defined under this node.