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

Interface DeclaredStatement<A>

Type Parameters:

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

All Superinterfaces:

ModelStatement<A>

All Known Subinterfaces:

ActionStatement, ActionStatementAwareDeclaredStatement<A>, AliasStatement, AnnotationStatement, AnydataStatement, AnyxmlSchemaLocationStatement, AnyxmlStatement, ArgumentStatement, AugmentStatement, BaseStatement, BelongsToStatement, BitStatement, BodyDeclaredStatement, CaseStatement, ChoiceStatement, ConfigStatement, ConfigStatementAwareDeclaredStatement<A>, ConstrainedDocumentedDeclaredStatement<T>, ConstrainedDocumentedDeclaredStatement.WithStatus<T>, ContactStatement, ContainerStatement, DataDefinitionAwareDeclaredStatement<A>, DataDefinitionAwareDeclaredStatement.WithReusableDefinitions<A>, DataDefinitionStatement, DefaultDenyAllStatement, DefaultDenyWriteStatement, DefaultStatement, DefaultStatementAwareDeclaredStatement, DefValStatement, DescriptionStatement, DeviateStatement, DeviationStatement, DisplayHintStatement, DocumentedDeclaredStatement<T>, DocumentedDeclaredStatement.WithStatus<T>, EnumStatement, ErrorAppTagStatement, ErrorMessageStatement, ExtensionStatement, FeatureStatement, FractionDigitsStatement, GetFilterElementAttributesStatement, GroupingStatement, IdentityStatement, IfFeatureAwareDeclaredStatement<A>, IfFeatureStatement, ImpliedStatement, ImportStatement, IncludeStatement, InputStatement, KeyStatement, LeafListStatement, LeafStatement, LengthStatement, LinkageDeclaredStatement, ListStatement, MandatoryStatement, MandatoryStatementAwareDeclaredStatement<T>, MaxAccessStatement, MaxElementsStatement, MetaDeclaredStatement<T>, MinElementsStatement, ModifierStatement, ModuleStatement, MountPointStatement, MultipleElementsDeclaredStatement, MustStatement, MustStatementAwareDeclaredStatement<A>, NamespaceStatement, NotificationStatement, NotificationStatementAwareDeclaredStatement<A>, OidStatement, OpenConfigHashedValueStatement, OpenConfigVersionStatement, OperationDeclaredStatement, OrderedByStatement, OrganizationStatement, OutputStatement, PathStatement, PatternStatement, PositionStatement, PrefixStatement, PresenceStatement, RangeStatement, ReferenceStatement, RefineStatement, RequireInstanceStatement, RevisionAwareDeclaredStatement, RevisionDateStatement, RevisionStatement, RpcStatement, StatusStatement, SubIdStatement, SubmoduleStatement, TypeAwareDeclaredStatement, TypedefStatement, TypeStatement, TypeStatement.BinarySpecification, TypeStatement.BitsSpecification, TypeStatement.Decimal64Specification, TypeStatement.EnumSpecification, TypeStatement.IdentityRefSpecification, TypeStatement.InstanceIdentifierSpecification, TypeStatement.LeafrefSpecification, TypeStatement.NumericalRestrictions, TypeStatement.StringRestrictions, TypeStatement.UnionSpecification, UniqueStatement, UnitsStatement, UnknownStatement<A>, UnrecognizedStatement, UsesStatement, ValueStatement, WhenStatement, WhenStatementAwareDeclaredStatement<A>, YangDataStatement, YangVersionStatement, YinElementStatement

All Known Implementing Classes:

AbstractDeclaredEffectiveRootStatement, AbstractDeclaredStatement, AbstractDeclaredStatement, AbstractDeclaredStatement.ArgumentToString, AbstractDeclaredStatement.ArgumentToString.WithSubstatements, AbstractDeclaredStatement.WithArgument, AbstractDeclaredStatement.WithArgument.WithSubstatements, AbstractDeclaredStatement.WithoutArgument, AbstractDeclaredStatement.WithoutArgument.WithSubstatements, AbstractDeclaredStatement.WithQNameArgument, AbstractDeclaredStatement.WithQNameArgument.WithSubstatements, AbstractDeclaredStatement.WithRawArgument, AbstractDeclaredStatement.WithRawStringArgument, AbstractDeclaredStatement.WithRawStringArgument.WithSubstatements

public interface DeclaredStatement<A>
extends ModelStatement<A>

Represents declared statement.

Method Summary

Modifier and Type	Method	Description
@NonNull Collection<? extends DeclaredStatement<?>>	declaredSubstatements()	Returns collection of explicitly declared child statements, while preserving its original ordering from original source.
default <T extends DeclaredStatement<?>> @NonNull Collection<? extends T>	declaredSubstatements(Class<T> type)	Returns collection of explicitly declared child statements, while preserving its original ordering from original source.
default <T extends DeclaredStatement<?>> @NonNull Optional<T>	findFirstDeclaredSubstatement(@NonNull Class<T> type)	Find the first effective substatement of specified type.
default <V,T extends DeclaredStatement<V>> @NonNull Optional<V>	findFirstDeclaredSubstatementArgument(@NonNull Class<T> type)	Find the first declared substatement of specified type and return its value.
@Nullable String	rawArgument()	Returns statement argument as was present in original source.
default <T extends DeclaredStatement<?>> @NonNull Stream<T>	streamDeclaredSubstatements(@NonNull Class<T> type)	Find all declared 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

rawArgument

@Nullable String rawArgument()

Returns statement argument as was present in original source.

Returns:

statement argument as was present in original source or null, if statement does not take argument.

declaredSubstatements

@NonNull Collection<? extends DeclaredStatement<?>> declaredSubstatements()

Returns collection of explicitly declared child statements, while preserving its original ordering from original source.

Returns:

Collection of statements, which were explicitly declared in source of model.

declaredSubstatements

default <T extends DeclaredStatement<?>> @NonNull Collection<? extends T> declaredSubstatements(Class<T> type)

Returns collection of explicitly declared child statements, while preserving its original ordering from original source.

Type Parameters:

T - substatement type

Parameters:

type - DeclaredStatement type

Returns:

Collection of statements, which were explicitly declared in source of model.

Throws:

NullPointerException - if type is null

findFirstDeclaredSubstatement

@Beta
default <T extends DeclaredStatement<?>> @NonNull Optional<T> findFirstDeclaredSubstatement(@NonNull Class<T> type)

Find the first effective substatement of specified type.

Type Parameters:

T - substatement type

Parameters:

type - DeclaredStatement type

Returns:

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

Throws:

NullPointerException - if type is null

findFirstDeclaredSubstatementArgument

@Beta
default <V,T extends DeclaredStatement<V>> @NonNull Optional<V> findFirstDeclaredSubstatementArgument(@NonNull Class<T> type)

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

Type Parameters:

T - substatement type

V - substatement argument type

Parameters:

type - DeclaredStatement type

Returns:

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

Throws:

NullPointerException - if type is null

streamDeclaredSubstatements

@Beta
default <T extends DeclaredStatement<?>> @NonNull Stream<T> streamDeclaredSubstatements(@NonNull Class<T> type)

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

Type Parameters:

T - substatement type

Parameters:

type - DeclaredStatement type

Returns:

A stream of all declared substatements of specified type.

Throws:

NullPointerException - if type is null