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

Interface DataSchemaNode

All Superinterfaces:

AddedByUsesAware, CopyableNode, DocumentedNode, DocumentedNode.WithStatus, SchemaNode, WhenConditionAware

All Known Subinterfaces:

AnnotationSchemaNodeAwareSchemaContext, AnydataSchemaNode, AnyxmlSchemaNode, CaseSchemaNode, ChoiceSchemaNode, ContainerLike, ContainerSchemaNode, EffectiveModelContext, EffectiveStatementMixins.DataSchemaNodeMixin<D>, EffectiveStatementMixins.OpaqueDataSchemaNodeMixin<D>, EffectiveStatementMixins.OperationContainerMixin<D>, InputSchemaNode, LeafListSchemaNode, LeafSchemaNode, ListSchemaNode, OutputSchemaNode, SchemaContext, TypedDataSchemaNode

All Known Implementing Classes:

AbstractChoiceEffectiveStatement, AbstractContainerEffectiveStatement, AbstractLeafEffectiveStatement, AbstractSchemaContext, DeclaredCaseEffectiveStatement, DeclaredInputEffectiveStatement, DeclaredOutputEffectiveStatement, EffectiveSchemaContext, EmptyAnydataEffectiveStatement, EmptyAnyxmlEffectiveStatement, EmptyChoiceEffectiveStatement, EmptyContainerEffectiveStatement, EmptyLeafEffectiveStatement, EmptyLeafListEffectiveStatement, EmptyListEffectiveStatement, FilteringSchemaContextProxy, NotificationAsContainer, OperationAsContainer, RegularAnydataEffectiveStatement, RegularAnyxmlEffectiveStatement, RegularChoiceEffectiveStatement, RegularContainerEffectiveStatement, RegularLeafEffectiveStatement, RegularLeafListEffectiveStatement, RegularListEffectiveStatement, SimpleSchemaContext, SlimLeafListEffectiveStatement, UndeclaredCaseEffectiveStatement, UndeclaredInputEffectiveStatement, UndeclaredLeafEffectiveStatement, UndeclaredOutputEffectiveStatement

public interface DataSchemaNode
extends SchemaNode, CopyableNode, WhenConditionAware

Data Schema Node represents abstract supertype from which all data tree definitions are derived. Unlike what the name would suggest, this interface corresponds more to RFC7950 data definition statement than to data node, yet it notably does not include UsesNode and AugmentationSchemaNode, which are resolved separately.

Common interface is composed of isConfiguration(), governing validity in config/operation data stores and WhenConditionAware mixin, which governs validity based on other document data.

See Also:

ContainerSchemaNode, ListSchemaNode, LeafListSchemaNode, ChoiceSchemaNode, CaseSchemaNode, LeafSchemaNode, AnyxmlSchemaNode, AnydataSchemaNode

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
Optional<Boolean>	effectiveConfig()	Return the effective value of config substatement, if applicable.
default boolean	isConfiguration()	Deprecated, for removal: This API element is subject to removal in a future version. Use effectiveConfig() instead.

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

isAddedByUses

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

isAugmenting

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

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

getQName

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

getWhenCondition

Method Detail

isConfiguration

@Deprecated(forRemoval=true)
default boolean isConfiguration()

Deprecated, for removal: This API element is subject to removal in a future version.

Use effectiveConfig() instead.

Returns true if the data represents configuration data, otherwise returns false.

Returns:

true if the data represents configuration data, otherwise returns false

effectiveConfig

Optional<Boolean> effectiveConfig()

Return the effective value of config substatement, if applicable.

Returns:

Effective config value, or Optional.empty() not applicable.