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

Interface SchemaTreeAwareEffectiveStatement<A,D extends DeclaredStatement<A>>

Type Parameters:

A - Argument type

D - Class representing declared version of this statement.

All Superinterfaces:

EffectiveStatement<A,D>, ModelStatement<A>

All Known Subinterfaces:

ActionEffectiveStatement, ActionNodeContainerCompat<A,D,E>, AugmentEffectiveStatement, CaseEffectiveStatement, ChoiceEffectiveStatement, ContainerEffectiveStatement, DataTreeAwareEffectiveStatement<A,D>, GroupingEffectiveStatement, InputEffectiveStatement, ListEffectiveStatement, ModuleEffectiveStatement, NotificationEffectiveStatement, NotificationNodeContainerCompat<A,D,E>, OutputEffectiveStatement, RpcEffectiveStatement, SubmoduleEffectiveStatement, YangDataEffectiveStatement

All Known Implementing Classes:

AbstractChoiceEffectiveStatement, AbstractContainerEffectiveStatement, AbstractEffectiveModule, AbstractGroupingEffectiveStatement, ActionEffectiveStatementImpl, AugmentEffectiveStatementImpl, DeclaredCaseEffectiveStatement, DeclaredInputEffectiveStatement, DeclaredOutputEffectiveStatement, EmptyChoiceEffectiveStatement, EmptyContainerEffectiveStatement, EmptyGroupingEffectiveStatement, EmptyListEffectiveStatement, NotificationEffectiveStatementImpl, RegularChoiceEffectiveStatement, RegularContainerEffectiveStatement, RegularGroupingEffectiveStatement, RegularListEffectiveStatement, RpcEffectiveStatementImpl, UndeclaredCaseEffectiveStatement, UndeclaredInputEffectiveStatement, UndeclaredOutputEffectiveStatement

@Beta
public interface SchemaTreeAwareEffectiveStatement<A,D extends DeclaredStatement<A>>
extends EffectiveStatement<A,D>

Interface implemented by all EffectiveStatements which can contain a schema tree child. This tree can be walked using SchemaNodeIdentifier, looking up each component of SchemaNodeIdentifier.getNodeIdentifiers() using findSchemaTreeNode(QName).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace	Namespace of schema nodes defined within this node.

Method Summary

Modifier and Type	Method	Description
default <E> @NonNull Optional<E>	findSchemaTreeNode(@NonNull Class<E> type, @NonNull List<QName> qnames)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.
default <E> @NonNull Optional<E>	findSchemaTreeNode(@NonNull Class<E> type, @NonNull QName qname)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.
default <E> @NonNull Optional<E>	findSchemaTreeNode(@NonNull Class<E> type, @NonNull QName... qnames)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.
default <E> @NonNull Optional<E>	findSchemaTreeNode(@NonNull Class<E> type, @NonNull SchemaNodeIdentifier.Descendant descendant)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its descendant schema node identifier.
default @NonNull Optional<SchemaTreeEffectiveStatement<?>>	findSchemaTreeNode(@NonNull List<QName> qnames)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.
default @NonNull Optional<SchemaTreeEffectiveStatement<?>>	findSchemaTreeNode(@NonNull QName qname)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.
default @NonNull Optional<SchemaTreeEffectiveStatement<?>>	findSchemaTreeNode(@NonNull QName... qnames)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.
default @NonNull Optional<SchemaTreeEffectiveStatement<?>>	findSchemaTreeNode(@NonNull SchemaNodeIdentifier.Descendant descendant)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its descendant schema node identifier.

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement

effectiveSubstatements, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, get, getAll, getDeclared, statementOrigin, streamEffectiveSubstatements

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.ModelStatement

argument, statementDefinition

Method Details

findSchemaTreeNode

default @NonNull Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(@NonNull QName qname)

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.

Parameters:

qname - Child identifier

Returns:

Schema tree child, or empty

Throws:

NullPointerException - if qname is null

findSchemaTreeNode

default <E> @NonNull Optional<E> findSchemaTreeNode(@NonNull Class<E> type,
 @NonNull QName qname)

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.

Type Parameters:

E - Effective substatement type

Parameters:

type - Effective substatement class

qname - Child identifier

Returns:

Schema tree child, or empty

Throws:

NullPointerException - if any argument is null

findSchemaTreeNode

default @NonNull Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(@NonNull QName... qnames)

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.

Parameters:

qnames - Child identifiers

Returns:

Schema tree child, or empty

Throws:

NullPointerException - if qnames is null or contains a null element

NoSuchElementException - if qnames is empty

findSchemaTreeNode

default <E> @NonNull Optional<E> findSchemaTreeNode(@NonNull Class<E> type,
 @NonNull QName... qnames)

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.

Type Parameters:

E - Effective substatement type

Parameters:

type - Effective substatement class

qnames - Child identifiers

Returns:

Schema tree child, or empty

Throws:

NullPointerException - if any argument is null or if qnames contains a null element

NoSuchElementException - if qnames is empty

findSchemaTreeNode

default @NonNull Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(@NonNull List<QName> qnames)

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.

Parameters:

qnames - Child identifiers

Returns:

Schema tree child, or empty

Throws:

NullPointerException - if qnames is null or contains a null element

NoSuchElementException - if qnames is empty

findSchemaTreeNode

default <E> @NonNull Optional<E> findSchemaTreeNode(@NonNull Class<E> type,
 @NonNull List<QName> qnames)

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.

Type Parameters:

E - Effective substatement type

Parameters:

type - Effective substatement class

qnames - Child identifiers

Returns:

Schema tree child, or empty

Throws:

NullPointerException - if qnames is null or contains a null element

NoSuchElementException - if qnames is empty

findSchemaTreeNode

default @NonNull Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(@NonNull SchemaNodeIdentifier.Descendant descendant)

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its descendant schema node identifier.

Parameters:

descendant - Descendant schema node identifier

Returns:

Schema tree child, or empty

Throws:

NullPointerException - if descendant is null

Implementation Requirements:

Default implementation defers to findSchemaTreeNode(List).

findSchemaTreeNode

default <E> @NonNull Optional<E> findSchemaTreeNode(@NonNull Class<E> type,
 @NonNull SchemaNodeIdentifier.Descendant descendant)

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its descendant schema node identifier.

Type Parameters:

E - Effective substatement type

Parameters:

type - Effective substatement class

descendant - Descendant schema node identifier

Returns:

Schema tree child, or empty

Throws:

NullPointerException - if descendant is null

Implementation Requirements:

Default implementation defers to findSchemaTreeNode(Class, List).