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

Interface SchemaNode

All Superinterfaces:

DocumentedNode, DocumentedNode.WithStatus

All Known Subinterfaces:

ActionDefinition, AliasSchemaNode, AnnotationSchemaNode, AnnotationSchemaNodeAwareSchemaContext, AnydataSchemaNode, AnyxmlSchemaNode, BinaryTypeDefinition, BitsTypeDefinition, BooleanTypeDefinition, CaseSchemaNode, ChoiceSchemaNode, ContainerLike, ContainerSchemaNode, DataSchemaNode, DecimalTypeDefinition, DefaultDenyAllSchemaNode, DefaultDenyWriteSchemaNode, DefValSchemaNode, DerivableSchemaNode, DisplayHintSchemaNode, EffectiveModelContext, EffectiveStatementMixins.DataSchemaNodeMixin<A,D>, EffectiveStatementMixins.OpaqueDataSchemaNodeMixin<D>, EffectiveStatementMixins.OperationContainerMixin<D>, EffectiveStatementMixins.OperationDefinitionMixin<D>, EffectiveStatementMixins.SchemaNodeMixin<A,D>, EffectiveStatementMixins.UnknownSchemaNodeMixin<A,D>, EmptyTypeDefinition, EnumTypeDefinition, ExtensionDefinition, FeatureDefinition, GetFilterElementAttributesSchemaNode, GroupingDefinition, IdentityrefTypeDefinition, IdentitySchemaNode, IdentityTypeDefinition, ImpliedSchemaNode, InputSchemaNode, InstanceIdentifierTypeDefinition, Int16TypeDefinition, Int32TypeDefinition, Int64TypeDefinition, Int8TypeDefinition, LeafListSchemaNode, LeafrefTypeDefinition, LeafSchemaNode, LengthRestrictedTypeDefinition<T>, ListSchemaNode, MaxAccessSchemaNode, MountPointSchemaNode, NotificationDefinition, OidSchemaNode, OpenConfigHashedValueSchemaNode, OperationDefinition, OutputSchemaNode, RangeRestrictedTypeDefinition<T,N>, RequireInstanceRestrictedTypeDefinition<T>, RpcDefinition, SchemaContext, StringTypeDefinition, SubIdSchemaNode, TypedDataSchemaNode, TypeDefinition<T>, Uint16TypeDefinition, Uint32TypeDefinition, Uint64TypeDefinition, Uint8TypeDefinition, UnionTypeDefinition, UnknownSchemaNode, UnknownTypeDefinition, YangDataSchemaNode

All Known Implementing Classes:

AbstractLeafEffectiveStatement, AbstractSchemaContext, ActionEffectiveStatementImpl, ChoiceEffectiveStatementImpl, ContainerEffectiveStatementImpl, DeclaredCaseEffectiveStatement, DeclaredInputEffectiveStatement, DeclaredOutputEffectiveStatement, EffectiveSchemaContext, EmptyAnydataEffectiveStatement, EmptyAnyxmlEffectiveStatement, EmptyFeatureEffectiveStatement, EmptyIdentityEffectiveStatement, EmptyLeafEffectiveStatement, ExtensionEffectiveStatementImpl, FilteringSchemaContextProxy, GroupingEffectiveStatementImpl, NotificationAsContainer, NotificationEffectiveStatementImpl, OperationAsContainer, RegularAnydataEffectiveStatement, RegularAnyxmlEffectiveStatement, RegularFeatureEffectiveStatement, RegularIdentityEffectiveStatement, RegularLeafEffectiveStatement, RpcEffectiveStatementImpl, SimpleSchemaContext, TypedefEffectiveStatementImpl, UndeclaredCaseEffectiveStatement, UndeclaredInputEffectiveStatement, UndeclaredOutputEffectiveStatement, UnknownEffectiveStatementBase

public interface SchemaNode
extends DocumentedNode.WithStatus

SchemaNode represents a node in schema tree.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method	Description
default @NonNull SchemaPath	getPath()	Deprecated. The idea of identifying SchemaNodes through a global path does not work.
@NonNull QName	getQName()	Returns QName of the instance of the type SchemaNode.

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

getDescription, getReference, getUnknownSchemaNodes

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus

getStatus

Method Detail

getQName

@NonNull QName getQName()

Returns QName of the instance of the type SchemaNode.

Returns:

QName with the name of the schema node

getPath

@Deprecated
default @NonNull SchemaPath getPath()

Deprecated.

The idea of identifying SchemaNodes through a global path does not work. There are two problems:

• SchemaPath does not work because it does not discern namespaces, i.e. we do not known whether the QName refers to a grouping, a typedef or a container.
• Such a path needs to be maintained by each SchemaNode and requires us to instantiate each effective statement as a separate object (because getPath() is effectively an identity within a given EffectiveModelContext.

Returns the schema path of the instance of the type SchemaNode.

The default implementation throws an UnsupportedOperationException.

Returns:

schema path of the schema node

Throws:

UnsupportedOperationException - when the implementation does not support per-node unique paths