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

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

Type Parameters:

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

S - Class representing declared version of this statement.

All Superinterfaces:

ModelStatement<A>

All Known Subinterfaces:

ActionEffectiveStatement, AnnotationEffectiveStatement, AnydataEffectiveStatement, AnyxmlEffectiveStatement, AnyxmlSchemaLocationEffectiveStatement, ArgumentEffectiveStatement, AugmentEffectiveStatement, BaseEffectiveStatement, BelongsToEffectiveStatement, BitEffectiveStatement, CaseEffectiveStatement, ChoiceEffectiveStatement, ConfigEffectiveStatement, ContactEffectiveStatement, ContainerEffectiveStatement, DefaultDenyAllEffectiveStatement, DefaultDenyWriteEffectiveStatement, 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, OpenConfigHashedValueEffectiveStatement, OpenConfigVersionEffectiveStatement, OrderedByEffectiveStatement, OrganizationEffectiveStatement, OutputEffectiveStatement, PathEffectiveStatement, PatternEffectiveStatement, PositionEffectiveStatement, PrefixEffectiveStatement, PresenceEffectiveStatement, RangeEffectiveStatement, ReferenceEffectiveStatement, RefineEffectiveStatement, RequireInstanceEffectiveStatement, RevisionDateEffectiveStatement, RevisionEffectiveStatement, RpcEffectiveStatement, StatusEffectiveStatement, SubmoduleEffectiveStatement, TypedefEffectiveStatement, TypeEffectiveStatement<T>, UniqueEffectiveStatement, UnitsEffectiveStatement, UnknownEffectiveStatement<A>, UnrecognizedEffectiveStatement, UsesEffectiveStatement, ValueEffectiveStatement, WhenEffectiveStatement, YangDataEffectiveStatement, YangVersionEffectiveStatement, YinElementEffectiveStatement

All Known Implementing Classes:

AbstractConstraintEffectiveStatement, AbstractEffectiveContainerSchemaNode, AbstractEffectiveDataSchemaNode, AbstractEffectiveDocumentedDataNodeContainer, AbstractEffectiveDocumentedNode, AbstractEffectiveModule, AbstractEffectiveOperationContainerSchemaNode, AbstractEffectiveOperationDefinition, AbstractEffectiveSchemaNode, AbstractEffectiveSimpleDataNodeContainer, AbstractListConstraintEffectiveStatement, AnyxmlEffectiveStatementImpl, AnyxmlSchemaLocationEffectiveStatementImpl, BitEffectiveStatementImpl, BitsSpecificationEffectiveStatement, ConfigEffectiveStatementImpl, ContainerEffectiveStatementImpl, Decimal64SpecificationEffectiveStatement, DeclaredEffectiveStatementBase, EffectiveStatementBase, EnumEffectiveStatementImpl, EnumSpecificationEffectiveStatement, ForwardingEffectiveStatement, IdentityRefSpecificationEffectiveStatement, LeafEffectiveStatementImpl, LeafListEffectiveStatementImpl, LeafrefSpecificationEffectiveStatement, LengthEffectiveStatementImpl, ListEffectiveStatementImpl, RangeEffectiveStatementImpl, RefineEffectiveStatementImpl, UndeclaredEffectiveStatementBase, UnionSpecificationEffectiveStatement, UnknownEffectiveStatementBase

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

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

Method Summary

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

Method Detail

getDeclared

@Nullable
S 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

@Nullable
<K,V,N extends IdentifierNamespace<K,V>> 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, null otherwise.

getAll

@Nullable
<K,V,N extends IdentifierNamespace<K,V>> 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:

Value if present, null otherwise.

findAll

default <K,V,N extends IdentifierNamespace<K,V>> @NonNull Map<K,V> findAll(@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.

effectiveSubstatements

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

Returns a collection of all effective substatements.

Returns:

collection of all effective substatements.

findFirstEffectiveSubstatement

@Beta
default <T extends EffectiveStatement<?,?>> Optional<T> findFirstEffectiveSubstatement(@Nonnull
                                                                                             Class<T> type)

Find the first effective substatement of specified 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.

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.

Returns:

A stream of all effective substatements of specified type.