Module org.opendaylight.yangtools.yang.model.api

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

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

Type Parameters:

A - Argument type (Empty if statement does not have argument.)

D - Class representing declared version of this statement.

All Superinterfaces:

ModelStatement<A>

All Known Subinterfaces:

ActionEffectiveStatement, ActionNodeContainerCompat<A,D,E>, AnydataEffectiveStatement, AnyxmlEffectiveStatement, ArgumentEffectiveStatement, AugmentEffectiveStatement, BaseEffectiveStatement, BelongsToEffectiveStatement, BitEffectiveStatement, CaseEffectiveStatement, ChoiceEffectiveStatement, ConfigEffectiveStatement, ContactEffectiveStatement, ContainerEffectiveStatement, DataTreeAwareEffectiveStatement<A,D>, DataTreeEffectiveStatement<D>, DefaultEffectiveStatement, DescriptionEffectiveStatement, DeviateEffectiveStatement, DeviationEffectiveStatement, EnumEffectiveStatement, ErrorAppTagEffectiveStatement, ErrorMessageEffectiveStatement, ExtensionEffectiveStatement, FeatureEffectiveStatement, FractionDigitsEffectiveStatement, GroupingEffectiveStatement, IdentityEffectiveStatement, IfFeatureEffectiveStatement, ImportEffectiveStatement, IncludeEffectiveStatement, InputEffectiveStatement, KeyEffectiveStatement, LeafEffectiveStatement, LeafListEffectiveStatement, LengthEffectiveStatement, ListEffectiveStatement, MandatoryEffectiveStatement, MaxElementsEffectiveStatement, MinElementsEffectiveStatement, ModifierEffectiveStatement, ModuleEffectiveStatement, MustEffectiveStatement, NamespacedEffectiveStatement<D>, NamespaceEffectiveStatement, NotificationEffectiveStatement, NotificationNodeContainerCompat<A,D,E>, OrderedByEffectiveStatement, OrganizationEffectiveStatement, OutputEffectiveStatement, PathEffectiveStatement, PatternEffectiveStatement, PositionEffectiveStatement, PrefixEffectiveStatement, PresenceEffectiveStatement, RangeEffectiveStatement, ReferenceEffectiveStatement, RefineEffectiveStatement, RequireInstanceEffectiveStatement, RevisionDateEffectiveStatement, RevisionEffectiveStatement, RpcEffectiveStatement, SchemaTreeAwareEffectiveStatement<A,D>, SchemaTreeEffectiveStatement<D>, StatusEffectiveStatement, SubmoduleEffectiveStatement, TypedefEffectiveStatement, TypeEffectiveStatement<T>, UniqueEffectiveStatement, UnitsEffectiveStatement, UnknownEffectiveStatement<A,D>, UsesEffectiveStatement, ValueEffectiveStatement, WhenEffectiveStatement, YangVersionEffectiveStatement, YinElementEffectiveStatement

public interface EffectiveStatement<A,D extends DeclaredStatement<A>>
extends ModelStatement<A>

Effective model statement which should be used to derive application behaviour.

Method Summary

Modifier and Type	Method	Description
@NonNull Collection<? extends @NonNull EffectiveStatement<?,?>>	effectiveSubstatements()	Returns a collection of all effective substatements.
default <T> Optional<T>	findFirstEffectiveSubstatement(@NonNull Class<T> type)	Find the first effective substatement of specified type.
default <V,T extends EffectiveStatement<V,?>> Optional<V>	findFirstEffectiveSubstatementArgument(@NonNull Class<T> type)	Find the first effective substatement of specified type and return its value.
<K,V,N extends IdentifierNamespace<K,V>> Optional<? extends V>	get(@NonNull Class<N> namespace, @NonNull K identifier)	Returns value associated with supplied identifier.
<K,V,N extends IdentifierNamespace<K,V>> @NonNull Map<K,V>	getAll(@NonNull Class<N> namespace)	Returns all local values from supplied namespace.
@Nullable D	getDeclared()	Returns statement, which was explicit declaration of this effective statement.
default <T extends EffectiveStatement<?,?>> Stream<T>	streamEffectiveSubstatements(@NonNull Class<T> type)	Find all effective substatements of specified type and return them as a stream.

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

argument, statementDefinition, statementOrigin

Method Detail

getDeclared

@Nullable D getDeclared()

Returns statement, which was explicit declaration of this effective statement.

Returns:

statement, which was explicit declaration of this effective statement or null if statement was inferred from context.

get

<K,V,N extends IdentifierNamespace<K,V>> Optional<? extends V> get(@NonNull Class<N> namespace,
                                                                                     @NonNull K identifier)

Returns value associated with supplied identifier.

Type Parameters:

K - Identifier type

V - Value type

N - Namespace identifier type

Parameters:

namespace - Namespace type

identifier - Identifier of element.

Returns:

Value if present

getAll

<K,V,N extends IdentifierNamespace<K,V>> @NonNull Map<K,V> getAll(@NonNull Class<N> namespace)

Returns all local values from supplied namespace.

Type Parameters:

K - Identifier type

V - Value type

N - Namespace identifier type

Parameters:

namespace - Namespace type

Returns:

Key-value mappings, empty if the namespace does not exist.

Throws:

NullPointerException - if namespace is null

effectiveSubstatements

@NonNull Collection<? extends @NonNull EffectiveStatement<?,?>> effectiveSubstatements()

Returns a collection of all effective substatements.

Returns:

collection of all effective substatements.

findFirstEffectiveSubstatement

@Beta
default <T> Optional<T> findFirstEffectiveSubstatement(@NonNull Class<T> type)

Find the first effective substatement of specified type.

Type Parameters:

T - substatement type

Parameters:

type - substatement type

Returns:

First effective substatement, or empty if no match is found.

findFirstEffectiveSubstatementArgument

@Beta
default <V,T extends EffectiveStatement<V,?>> Optional<V> findFirstEffectiveSubstatementArgument(@NonNull Class<T> type)

Find the first effective substatement of specified type and return its value.

Type Parameters:

T - substatement type

V - substatement argument type

Parameters:

type - substatement type

Returns:

First effective substatement's argument, or empty if no match is found.

streamEffectiveSubstatements

@Beta
default <T extends EffectiveStatement<?,?>> Stream<T> streamEffectiveSubstatements(@NonNull Class<T> type)

Find all effective substatements of specified type and return them as a stream.

Type Parameters:

T - substatement type

Parameters:

type - substatement type

Returns:

A stream of all effective substatements of specified type.