org.opendaylight.yangtools.yang.model.api

Interface DocumentedNode

All Known Subinterfaces:

ActionDefinition, AnyDataSchemaNode, AnyXmlSchemaNode, BinaryTypeDefinition, BitsTypeDefinition, BitsTypeDefinition.Bit, BooleanTypeDefinition, ChoiceCaseNode, ChoiceSchemaNode, ContainerSchemaNode, DataSchemaNode, DecimalTypeDefinition, DerivableSchemaNode, DocumentedNode.WithStatus, EmptyTypeDefinition, EnumTypeDefinition, EnumTypeDefinition.EnumPair, ExtensionDefinition, FeatureDefinition, GroupingDefinition, IdentityrefTypeDefinition, IdentitySchemaNode, IdentityTypeDefinition, InstanceIdentifierTypeDefinition, IntegerTypeDefinition, LeafListSchemaNode, LeafrefTypeDefinition, LeafSchemaNode, ListSchemaNode, ModuleImport, NotificationDefinition, OperationDefinition, RequireInstanceRestrictedTypeDefinition<T>, RpcDefinition, SchemaContext, SchemaNode, StringTypeDefinition, TypeDefinition<T>, TypedSchemaNode, UnionTypeDefinition, UnknownSchemaNode, UnknownTypeDefinition, UnsignedIntegerTypeDefinition, UsesNode, YangDataSchemaNode, YangModeledAnyXmlSchemaNode

All Known Implementing Classes:

AbstractEffectiveDataSchemaNode, AbstractEffectiveDocumentedNode, AbstractEffectiveSchemaNode, AbstractSchemaContext, ActionEffectiveStatementImpl, AnyDataEffectiveStatementImpl, AnyXmlEffectiveStatementImpl, AnyxmlSchemaLocationEffectiveStatementImpl, AugmentEffectiveStatementImpl, BitEffectiveStatementImpl, CaseEffectiveStatementImpl, ChoiceEffectiveStatementImpl, ContainerEffectiveStatementImpl, EffectiveSchemaContext, EnumEffectiveStatementImpl, ExtensionEffectiveStatementImpl, FeatureEffectiveStatementImpl, FilteringSchemaContextProxy, GroupingEffectiveStatementImpl, IdentityEffectiveStatementImpl, ImportEffectiveStatementImpl, InputEffectiveStatementImpl, LeafEffectiveStatementImpl, LeafListEffectiveStatementImpl, ListEffectiveStatementImpl, ModuleEffectiveStatementImpl, NotificationEffectiveStatementImpl, OpenconfigVersionEffectiveStatementImpl, OutputEffectiveStatementImpl, RefineEffectiveStatementImpl, RevisionEffectiveStatementImpl, RpcAsContainer, RpcEffectiveStatementImpl, SimpleSchemaContext, SubmoduleEffectiveStatementImpl, TypeDefEffectiveStatementImpl, UnknownEffectiveStatementBase, UnknownEffectiveStatementImpl, UsesEffectiveStatementImpl, YangDataEffectiveStatement, YangModeledAnyXmlEffectiveStatementImpl

public interface DocumentedNode

Node which can have documentation assigned.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method and Description
default String	getDescription() All implementations should override this method.
default String	getReference() All implementations should override this method.
default List<UnknownSchemaNode>	getUnknownSchemaNodes() Returns unknown schema nodes which belongs to this instance.

Method Detail

getDescription

@Nullable
default String getDescription()

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

Returns:

string that represents the argument of description statement

getReference

@Nullable
default String getReference()

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

Returns:

string that represents the argument of reference statement

getUnknownSchemaNodes

@Nonnull
default List<UnknownSchemaNode> getUnknownSchemaNodes()

Returns unknown schema nodes which belongs to this instance.

Returns:

list of unknown schema nodes defined under this node.