net.digitalid.utility.collections.iterable

Interface ReadOnlyIterable<ELEMENT>

All Superinterfaces:

net.digitalid.utility.casting.Castable, Cloneable, net.digitalid.utility.functional.iterables.CollectionIterable<ELEMENT>, net.digitalid.utility.interfaces.Countable, net.digitalid.utility.functional.iterables.FiniteIterable<ELEMENT>, net.digitalid.utility.functional.iterables.FunctionalIterable<ELEMENT>, Iterable<ELEMENT>, net.digitalid.utility.freezable.ReadOnlyInterface, net.digitalid.utility.rootclass.RootInterface, net.digitalid.utility.validation.validatable.Validatable

All Known Subinterfaces:

FreezableCollection<E>, FreezableIterable<E>, FreezableList<E>, FreezableSet<E>, ReadOnlyArray<E>, ReadOnlyCollection<E>, ReadOnlyList<E>, ReadOnlySet<E>

All Known Implementing Classes:

BackedFreezableCollection, BackedFreezableList, BackedFreezableSet, FreezableArray, FreezableArrayList, FreezableHashSet, FreezableLinkedHashSet, FreezableLinkedList

@ReadOnly(value=FreezableIterable.class)
public interface ReadOnlyIterable<ELEMENT>
extends net.digitalid.utility.functional.iterables.CollectionIterable<ELEMENT>, net.digitalid.utility.freezable.ReadOnlyInterface

This interface provides read-only access to iterables and should never be cast away. It is recommended to use only ReadOnly or Immutable types for the elements.

See Also:

ReadOnlyCollection, ReadOnlyArray

Method Summary

Modifier and Type	Method and Description
@Nonnull @NonFrozen FreezableIterable<ELEMENT>	clone()
default @Nonnull @NonFrozen FreezableArray<ELEMENT>	toFreezableArray() Returns the elements of this collection as a freezable array.
default @Nonnull @NonFrozen FreezableList<ELEMENT>	toFreezableList() Returns the elements of this collection as a freezable list.
default <KEY,EXCEPTION extends Exception> @Nonnull @NonFrozen FreezableMap<KEY,ELEMENT>	toFreezableMap(@Nonnull net.digitalid.utility.functional.failable.FailableUnaryFunction<? super ELEMENT,? extends KEY,? extends EXCEPTION> function) Returns the elements of this iterable as a freezable map with their key determined by the given function.
default @Nonnull @NonFrozen FreezableSet<ELEMENT>	toFreezableSet() Returns the elements of this collection as a freezable set.

Methods inherited from interface net.digitalid.utility.functional.iterables.CollectionIterable

isEmpty, size, size

Methods inherited from interface net.digitalid.utility.functional.iterables.FiniteIterable

average, collect, combine, combine, contains, containsAll, containsAll, containsDuplicates, containsNull, count, distinct, doForEach, equals, evaluate, exclude, filter, filterNot, filterNulls, findFirst, findFirst, findLast, findLast, findUnique, flatten, flattenAll, flattenOne, getFirst, getFirst, getFirstOrNull, getLast, getLast, getLastOrNull, groupBy, indexOf, instanceOf, intersect, isAscending, isDescending, isEmptyOrSingle, isOrdered, isSingle, isStrictlyAscending, isStrictlyDescending, join, join, join, join, join, join, join, join, lastIndexOf, map, matchAll, matchAny, matchNone, max, max, max, max, min, min, min, min, of, of, reduce, reduce, repeated, reversed, skip, sorted, sorted, sumAsDouble, sumAsLong, toArray, toArray, toGenericArray, toList, toMap, toSet, zipLongest, zipShortest

Methods inherited from interface net.digitalid.utility.functional.iterables.FunctionalIterable

extract, get, hasSize, iterator, limit, sizeAtLeast, sizeAtMost, zipLongest, zipShortest

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.digitalid.utility.freezable.ReadOnlyInterface

isFrozen

Methods inherited from interface net.digitalid.utility.rootclass.RootInterface

equals, hashCode, toString

Methods inherited from interface net.digitalid.utility.casting.Castable

castTo

Methods inherited from interface net.digitalid.utility.validation.validatable.Validatable

validate

Method Detail

clone

@Pure
 @Capturable
 @Nonnull
 @NonFrozen
@Nonnull @NonFrozen FreezableIterable<ELEMENT> clone()

Specified by:

clone in interface net.digitalid.utility.freezable.ReadOnlyInterface

toFreezableArray

@Pure
 @Capturable
 @Nonnull
 @NonFrozen
default @Nonnull @NonFrozen FreezableArray<ELEMENT> toFreezableArray()

Returns the elements of this collection as a freezable array.

toFreezableList

@Pure
 @Capturable
 @Nonnull
 @NonFrozen
default @Nonnull @NonFrozen FreezableList<ELEMENT> toFreezableList()

Returns the elements of this collection as a freezable list.

toFreezableSet

@Pure
 @Capturable
 @Nonnull
 @NonFrozen
default @Nonnull @NonFrozen FreezableSet<ELEMENT> toFreezableSet()

Returns the elements of this collection as a freezable set.

toFreezableMap

@Pure
 @Capturable
 @Nonnull
 @NonFrozen
default <KEY,EXCEPTION extends Exception> @Nonnull @NonFrozen FreezableMap<KEY,ELEMENT> toFreezableMap(@Nonnull
                                                                                                                                                @Nonnull net.digitalid.utility.functional.failable.FailableUnaryFunction<? super ELEMENT,? extends KEY,? extends EXCEPTION> function)
                                                                                                                                         throws EXCEPTION extends Exception

Returns the elements of this iterable as a freezable map with their key determined by the given function.

Throws:

EXCEPTION extends Exception