net.digitalid.utility.collections.iterable

Interface FreezableIterable<E>

All Superinterfaces:

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

All Known Subinterfaces:

FreezableCollection<E>, FreezableList<E>, FreezableSet<E>

All Known Implementing Classes:

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

@Freezable(value=ReadOnlyIterable.class)
public interface FreezableIterable<E>
extends ReadOnlyIterable<E>, net.digitalid.utility.freezable.FreezableInterface

This interface models an iterable that can be frozen. As a consequence, all modifying methods may fail with a PreconditionException. It is recommended to use only ReadOnly or Immutable types for the elements.

See Also:

FreezableCollection, FreezableArray

Method Summary

Modifier and Type	Method and Description
default boolean	containsAll(@Nonnull FreezableCollection<?> collection) Returns whether this iterable contains all of the elements of the given collection.
@Nonnull @Frozen ReadOnlyIterable<E>	freeze()

Methods inherited from interface net.digitalid.utility.collections.iterable.ReadOnlyIterable

clone, toFreezableArray, toFreezableList, toFreezableMap, toFreezableSet

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

freeze

@Impure
 @NonFrozenRecipient
 @Chainable
 @Nonnull
 @Frozen
@Nonnull @Frozen ReadOnlyIterable<E> freeze()

Specified by:

freeze in interface net.digitalid.utility.freezable.FreezableInterface

containsAll

@Pure
default boolean containsAll(@NonCaptured @Unmodified @Nonnull
                                  @Nonnull FreezableCollection<?> collection)

Returns whether this iterable contains all of the elements of the given collection.