Module jonix.common

Package com.tectonica.jonix.common

Class ListOfOnixDataCompositeWithKey<C extends OnixComposite.OnixDataCompositeWithKey<S,K>,S extends JonixKeyedStruct<K>,K extends Enum<K> & OnixCodelist>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<C>

com.tectonica.jonix.common.ListOfOnixDataComposite<C,S>

com.tectonica.jonix.common.ListOfOnixDataCompositeWithKey<C,S,K>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<C>, Collection<C>, List<C>, RandomAccess

public class ListOfOnixDataCompositeWithKey<C extends OnixComposite.OnixDataCompositeWithKey<S,K>,S extends JonixKeyedStruct<K>,K extends Enum<K> & OnixCodelist>
extends ListOfOnixDataComposite<C,S>

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ListOfOnixDataCompositeWithKey(Class<C> clazz)

Method Summary

Modifier and Type	Method	Description
ListOfOnixDataCompositeWithKey<C,S,K>	filter(Predicate<C> predicate)	Given this list of OnixComposite.OnixDataCompositeWithKeys, this method creates a new list containing only a subset of items, or none, conforming to the condition passed in the Predicate object.
Optional<C>	find(K structKey)	Scans the items (i.e.
ListOfOnixDataCompositeWithKey<C,S,K>	findAll(Set<K> structKeys)	Scans the items (i.e.
ListOfOnixDataCompositeWithKey<C,S,K>	findAll(K... structKeys)	Scans the items (i.e.
List<S>	findAllAsStructs(Set<K> structKeys)	Same as findAll(Set), but returns a JonixStructs rather than the raw ONIX composites
List<S>	findAllAsStructs(K... structKeys)	Same as findAll(Enum[]), but returns a JonixStruct rather than the raw ONIX composite
Optional<C>	findAny(Set<K> structKeys)	Scans the items (i.e.
final Optional<C>	findAny(K... structKeys)	Scans the items (i.e.
Optional<S>	findAnyAsStruct(Set<K> structKeys)	Same as findAny(Set), but returns a JonixStruct rather than the raw ONIX composite
Optional<S>	findAsStruct(K structKey)	Same as find(Enum), but returns a JonixStruct rather than the raw ONIX composite
C	findOrEmpty(K structKey)
Class<C>	itemClass()

Methods inherited from class com.tectonica.jonix.common.ListOfOnixDataComposite

asStructs, first, firstAsStruct, firstOrEmpty, firstOrEmptyAsStruct, structsInto

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

ListOfOnixDataCompositeWithKey

public ListOfOnixDataCompositeWithKey(Class<C> clazz)

Method Details

itemClass

public Class<C> itemClass()

Overrides:

itemClass in class ListOfOnixDataComposite<C extends OnixComposite.OnixDataCompositeWithKey<S,K>,S extends JonixKeyedStruct<K>>

Returns:

the Class of the items in this List

find

public Optional<C> find(K structKey)

Scans the items (i.e. Data Composites) in this list, searching for the one that has the given key

Parameters:

structKey - the requested key

Returns:

an Optional with the found item (or empty Optional if none exists)

findAsStruct

public Optional<S> findAsStruct(K structKey)

Same as find(Enum), but returns a JonixStruct rather than the raw ONIX composite

findAny

public Optional<C> findAny(Set<K> structKeys)

Scans the items (i.e. Data Composites) in this list, searching for an arbitrary one whose key is included in the provided set

Parameters:

structKeys - set of the requested keys, as a Set object

Returns:

an Optional with the found item (or empty Optional if none exists)

findAny

@SafeVarargs
public final Optional<C> findAny(K... structKeys)

Scans the items (i.e. Data Composites) in this list, searching for an arbitrary one whose key is included in the provided set

Parameters:

structKeys - set of the requested keys, as arguments list

Returns:

an Optional with the found item (or empty Optional if none exists)

findAnyAsStruct

public Optional<S> findAnyAsStruct(Set<K> structKeys)

Same as findAny(Set), but returns a JonixStruct rather than the raw ONIX composite

findOrEmpty

public C findOrEmpty(K structKey)

Returns:

the first OnixComposite.OnixDataCompositeWithKey listed, if any, or an "empty" instance (whose OnixTag.exists() is false), which can be further traversed by your code (as if it exists in the ONIX source), with all underlying data fields eventually yielding "non-existing" value

filter

public ListOfOnixDataCompositeWithKey<C,S,K> filter(Predicate<C> predicate)

Given this list of OnixComposite.OnixDataCompositeWithKeys, this method creates a new list containing only a subset of items, or none, conforming to the condition passed in the Predicate object.

Note that this method is different from .stream().filter() in that it returns a list of the same original type (i.e. ListOfOnixDataCompositeWithKey), and not a generic Java List. This allows the caller to apply methods such as ListOfOnixDataComposite.firstOrEmpty() on the returned list.

Overrides:

filter in class ListOfOnixDataComposite<C extends OnixComposite.OnixDataCompositeWithKey<S,K>,S extends JonixKeyedStruct<K>>

Returns:

a non-null, possibly empty, sublist of items meeting the predicate condition

findAll

public ListOfOnixDataCompositeWithKey<C,S,K> findAll(Set<K> structKeys)

Scans the items (i.e. Data Composites) in this list, searching for all of those whose key is included in the provided set

Note that this method is different from .stream().filter() in that it returns a list of the same original type (i.e. ListOfOnixDataCompositeWithKey), and not a generic Java List. This allows the caller to apply methods such as ListOfOnixDataComposite.firstOrEmpty() on the returned list.

Parameters:

structKeys - set of the requested keys, as a Set object

Returns:

an Optional with the found item (or empty Optional if none exists)

findAllAsStructs

public List<S> findAllAsStructs(Set<K> structKeys)

Same as findAll(Set), but returns a JonixStructs rather than the raw ONIX composites

findAll

public ListOfOnixDataCompositeWithKey<C,S,K> findAll(K... structKeys)

Scans the items (i.e. Data Composites) in this list, searching for all of those whose key is included in the provided set

Parameters:

structKeys - set of the requested keys, as argument list

Returns:

an Optional with the found item (or empty Optional if none exists)

findAllAsStructs

public List<S> findAllAsStructs(K... structKeys)

Same as findAll(Enum[]), but returns a JonixStruct rather than the raw ONIX composite