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

Interface DocumentedNode

All Known Subinterfaces:
ActionDefinition, AliasSchemaNode, AnnotationSchemaNode, AnnotationSchemaNodeAwareSchemaContext, AnydataSchemaNode, AnyxmlSchemaNode, AugmentationSchemaNode, BinaryTypeDefinition, BitsTypeDefinition, BitsTypeDefinition.Bit, BooleanTypeDefinition, CaseSchemaNode, ChoiceSchemaNode, ConstraintMetaDefinition, ContainerLike, ContainerSchemaNode, DataSchemaNode, DecimalTypeDefinition, DefaultDenyAllSchemaNode, DefaultDenyWriteSchemaNode, DefValSchemaNode, Deviation, DisplayHintSchemaNode, DocumentedNode.WithStatus, EffectiveModelContext, EffectiveStatementMixins.ConstraintMetaDefinitionMixin<A,D>, EffectiveStatementMixins.DataSchemaNodeMixin<D>, EffectiveStatementMixins.DocumentedNodeMixin<A,D>, EffectiveStatementMixins.DocumentedNodeMixin.WithStatus<A,D>, EffectiveStatementMixins.OpaqueDataSchemaNodeMixin<D>, EffectiveStatementMixins.OperationContainerMixin<D>, EffectiveStatementMixins.OperationDefinitionMixin<D>, EffectiveStatementMixins.SchemaNodeMixin<D>, EffectiveStatementMixins.UnknownSchemaNodeMixin<A,D>, EmptyTypeDefinition, EnumTypeDefinition, EnumTypeDefinition.EnumPair, ExtensionDefinition, FeatureDefinition, GetFilterElementAttributesSchemaNode, GroupingDefinition, IdentityrefTypeDefinition, IdentitySchemaNode, IdentityTypeDefinition, ImpliedSchemaNode, InputSchemaNode, InstanceIdentifierTypeDefinition, Int16TypeDefinition, Int32TypeDefinition, Int64TypeDefinition, Int8TypeDefinition, LeafListSchemaNode, LeafrefTypeDefinition, LeafSchemaNode, LengthConstraint, LengthEffectiveStatement, LengthRestrictedTypeDefinition<T>, ListSchemaNode, MaxAccessSchemaNode, Module, ModuleImport, ModuleLike, MountPointSchemaNode, MustDefinition, NotificationDefinition, OidSchemaNode, OpenConfigHashedValueSchemaNode, OperationDefinition, OutputSchemaNode, PatternConstraint, PatternEffectiveStatement, RangeConstraint<T>, RangeEffectiveStatement, RangeRestrictedTypeDefinition<T,N>, RequireInstanceRestrictedTypeDefinition<T>, RpcDefinition, SchemaContext, SchemaNode, StringTypeDefinition, SubIdSchemaNode, Submodule, TypedDataSchemaNode, TypeDefinition<T>, Uint16TypeDefinition, Uint32TypeDefinition, Uint64TypeDefinition, Uint8TypeDefinition, UnionTypeDefinition, UnknownSchemaNode, UnknownTypeDefinition, UsesNode, YangDataSchemaNode
All Known Implementing Classes:
AbstractChoiceEffectiveStatement, AbstractContainerEffectiveStatement, AbstractEffectiveModule, AbstractEffectiveUnknownSchmemaNode, AbstractGroupingEffectiveStatement, AbstractLeafEffectiveStatement, AbstractSchemaContext, ActionEffectiveStatementImpl, AugmentEffectiveStatementImpl, DeclaredCaseEffectiveStatement, DeclaredInputEffectiveStatement, DeclaredOutputEffectiveStatement, DeviationEffectiveStatementImpl, EffectiveAugmentationSchema, EffectiveSchemaContext, EmptyAnydataEffectiveStatement, EmptyAnyxmlEffectiveStatement, EmptyBitEffectiveStatement, EmptyChoiceEffectiveStatement, EmptyContainerEffectiveStatement, EmptyEnumEffectiveStatement, EmptyFeatureEffectiveStatement, EmptyGroupingEffectiveStatement, EmptyIdentityEffectiveStatement, EmptyLeafEffectiveStatement, EmptyLeafListEffectiveStatement, EmptyLengthEffectiveStatement, EmptyListEffectiveStatement, EmptyMustEffectiveStatement, EmptyPatternEffectiveStatement, EmptyRangeEffectiveStatement, EmptyRevisionEffectiveStatement, ExtensionEffectiveStatementImpl, FilteringSchemaContextProxy, ImportEffectiveStatementImpl, NotificationAsContainer, NotificationEffectiveStatementImpl, OperationAsContainer, RefineEffectiveStatementImpl, RegularAnydataEffectiveStatement, RegularAnyxmlEffectiveStatement, RegularBitEffectiveStatement, RegularChoiceEffectiveStatement, RegularContainerEffectiveStatement, RegularEnumEffectiveStatement, RegularFeatureEffectiveStatement, RegularGroupingEffectiveStatement, RegularIdentityEffectiveStatement, RegularLeafEffectiveStatement, RegularLeafListEffectiveStatement, RegularLengthEffectiveStatement, RegularListEffectiveStatement, RegularMustEffectiveStatement, RegularPatternEffectiveStatement, RegularRangeEffectiveStatement, RegularRevisionEffectiveStatement, RpcEffectiveStatementImpl, SimpleSchemaContext, SlimLeafListEffectiveStatement, TypedefEffectiveStatementImpl, UndeclaredCaseEffectiveStatement, UndeclaredInputEffectiveStatement, UndeclaredLeafEffectiveStatement, UndeclaredOutputEffectiveStatement
public interface DocumentedNode
Node which can have documentation assigned.

  • Method Details

    • 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 Collection<? extends @NonNull UnknownSchemaNode> getUnknownSchemaNodes()
      Returns unknown schema nodes which belongs to this instance. Default implementation returns an empty collection.
      Returns:
      collection of unknown schema nodes defined under this node.