Package org.opendaylight.yangtools.yang.data.util

Interface DataSchemaContext

All Known Subinterfaces:

DataSchemaContext.Composite, DataSchemaContext.PathMixin, DataSchemaContext.SimpleValue

All Known Implementing Classes:

AbstractCompositeContext, AbstractContext, AbstractPathMixinContext, AbstractValueContext, ContainerContext, LeafContext, LeafListItemContext

public sealed interface DataSchemaContext
permits AbstractContext, DataSchemaContext.Composite, DataSchemaContext.SimpleValue

Schema derived data providing necessary information for mapping between NormalizedNode and serialization format defined in RFC6020, since the mapping is not one-to-one.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataSchemaContext.Composite	A DataSchemaContext containing other DataSchemaContexts.
static interface	DataSchemaContext.PathMixin	This node is a NormalizedNode intermediate, not represented in RFC7950 XML encoding.
static interface	DataSchemaContext.SimpleValue	Marker interface for contexts which boil down to a simple, not-structured ValueNode.

Method Summary

Modifier and Type	Method	Description
@NonNull DataSchemaNode	dataSchemaNode()
default @NonNull YangInstanceIdentifier.NodeIdentifier	getPathStep()	Return the fixed YangInstanceIdentifier step.
static @NonNull DataSchemaContext	of(DataSchemaNode schema)	Get a DataSchemaContext for a particular DataSchemaNode.
@Nullable YangInstanceIdentifier.NodeIdentifier	pathStep()	Return the fixed YangInstanceIdentifier step, if available.

Method Details

of

static @NonNull DataSchemaContext of(DataSchemaNode schema)

Get a DataSchemaContext for a particular DataSchemaNode.

Parameters:

schema - Backing DataSchemaNode

Returns:

A DataSchemaContext

Throws:

NullPointerException - if schema is null

IllegalStateException - if schema is not handled

dataSchemaNode

@NonNull DataSchemaNode dataSchemaNode()

pathStep

@Nullable YangInstanceIdentifier.NodeIdentifier pathStep()

Return the fixed YangInstanceIdentifier step, if available. This method returns null for contexts like MapEntryNode and LeafSetEntryNode, where the step depends on the actual node value.

Returns:

A YangInstanceIdentifier.NodeIdentifier, or null

getPathStep

default @NonNull YangInstanceIdentifier.NodeIdentifier getPathStep()

Return the fixed YangInstanceIdentifier step.

Returns:

A YangInstanceIdentifier.NodeIdentifier

Throws:

UnsupportedOperationException - if this node does not have fixed step