Module gov.nist.secauto.metaschema.core

Package gov.nist.secauto.metaschema.core.metapath

Interface ISequence<ITEM_TYPE extends IItem>

All Superinterfaces:

Iterable<ITEM_TYPE>

public interface ISequence<ITEM_TYPE extends IItem>
extends Iterable<ITEM_TYPE>

Field Summary

Fields

Modifier and Type	Field	Description
static ISequence	EMPTY

Method Summary

Modifier and Type	Method	Description
List<ITEM_TYPE>	asList()	Get the items in this sequence as a List.
Stream<ITEM_TYPE>	asStream()	Get the items in this sequence as a Stream.
void	collect()	This optional operation ensures that a list is used to back this sequence.
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE>	empty()	Get an empty sequence.
void	forEach(Consumer<? super ITEM_TYPE> action)	Iterate over each item in the sequence using the provided action.
boolean	isEmpty()	Determine if this sequence is empty.
default Iterator<ITEM_TYPE>	iterator()
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE>	of(ITEM_TYPE item)	Construct a new sequence containing the provided item.
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE>	of(List<ITEM_TYPE> items)	Construct a new sequence containing the provided items.
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE>	of(Stream<ITEM_TYPE> items)	Construct a new sequence containing the provided items.
int	size()	Get the count of items in this sequence.
static <ITEM_TYPE extends IItem> Collector<ITEM_TYPE,?,ISequence<ITEM_TYPE>>	toSequence()

Methods inherited from interface java.lang.Iterable

spliterator

Field Detail

EMPTY

static final ISequence EMPTY

Method Detail

empty

@NonNull
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE> empty()

Get an empty sequence.

Type Parameters:

ITEM_TYPE - the item type

Returns:

the empty sequence

of

@NonNull
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE> of(@Nullable
                                                         ITEM_TYPE item)

Construct a new sequence containing the provided item.

If the item is null and empty sequence will be created.

Type Parameters:

ITEM_TYPE - the type of items contained in the sequence.

Parameters:

item - the item to add to the sequence

Returns:

the new sequence

of

@NonNull
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE> of(@NonNull
                                                         List<ITEM_TYPE> items)

Construct a new sequence containing the provided items.

Type Parameters:

ITEM_TYPE - the type of items contained in the sequence.

Parameters:

items - the items to add to the sequence

Returns:

the new sequence

of

@NonNull
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE> of(Stream<ITEM_TYPE> items)

Construct a new sequence containing the provided items.

Type Parameters:

ITEM_TYPE - the type of items contained in the sequence.

Parameters:

items - the items to add to the sequence

Returns:

the new sequence

iterator

default Iterator<ITEM_TYPE> iterator()

Specified by:

iterator in interface Iterable<ITEM_TYPE extends IItem>

asList

@NonNull
List<ITEM_TYPE> asList()

Get the items in this sequence as a List.

Returns:

a list containing all the items of the sequence

asStream

@NonNull
Stream<ITEM_TYPE> asStream()

Get the items in this sequence as a Stream.

Returns:

a stream containing all the items of the sequence

collect

void collect()

This optional operation ensures that a list is used to back this sequence.

If a stream is currently backing this sequence, the stream will be collected into a list. This ensures the sequence can be visited multiple times.

isEmpty

boolean isEmpty()

Determine if this sequence is empty.

Returns:

true if the sequence contains no items, or false otherwise

size

int size()

Get the count of items in this sequence.

Returns:

the count of items

forEach

void forEach(Consumer<? super ITEM_TYPE> action)

Iterate over each item in the sequence using the provided action.

Specified by:

forEach in interface Iterable<ITEM_TYPE extends IItem>

Parameters:

action - code to execute for each item

toSequence

@NonNull
static <ITEM_TYPE extends IItem> Collector<ITEM_TYPE,?,ISequence<ITEM_TYPE>> toSequence()