Package org.comroid.mutatio.span

Class Span<T>

java.lang.Object

org.comroid.mutatio.span.Span<T>

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.function.Supplier<T>, org.comroid.api.SelfDeclared<Reference<T>>, org.comroid.api.Specifiable<Reference<T>>, Pipeable<T>, Reference<T>, ReferenceIndex<T>

public class Span<T>
extends java.lang.Object
implements java.util.Collection<T>, ReferenceIndex<T>, Reference<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Span.API<T>
static class	Span.DefaultModifyPolicy
class	Span.Iterator

Nested classes/interfaces inherited from interface org.comroid.mutatio.pipe.Pipeable

Pipeable.From<T>

Nested classes/interfaces inherited from interface org.comroid.mutatio.ref.Reference

Reference.Settable<T>, Reference.Support

Nested classes/interfaces inherited from interface org.comroid.mutatio.ref.ReferenceIndex

ReferenceIndex.Support

Field Summary

Fields

Modifier and Type	Field	Description
static Span.DefaultModifyPolicy	DEFAULT_MODIFY_POLICY
static int	UNFIXED_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
	Span()
	Span(int fixedCapacity)
protected	Span(ReferenceIndex<? extends T> data, int fixedCapacity, ModifyPolicy modifyPolicy)
	Span(ReferenceIndex<? extends T> data, ModifyPolicy modifyPolicy, boolean fixedSize)
	Span(ReferenceIndex<T> referenceIndex, ModifyPolicy modifyPolicy)

Method Summary

Modifier and Type	Method	Description
boolean	add(T it)
boolean	addAll(@NotNull java.util.Collection<? extends T> objects)
void	cleanup()
void	clear()	Deletes all elements
static <T> java.util.stream.Collector<T,?,Span<T>>	collector()
boolean	contains(java.lang.Object o)
boolean	containsAll(@NotNull java.util.Collection<?> objects)
static <T> Span<T>	empty()
T	get()
Reference<T>	getReference(int index)
static <T> Span<T>	immutable(java.util.Collection<T> of)
static <T> Span<T>	immutable(T... of)
<C extends java.util.Collection<T>> C	into(java.util.function.Supplier<C> collectionSupplier)
boolean	isEmpty()
boolean	isFixedSize()
boolean	isNotSingle()
boolean	isSingle()
@NotNull Span.Iterator	iterator()
static <T> Span.API<T>	make()
Pipe<?,T>	pipe()
Span<T>	range(int startIncl, int endExcl)
Span.API<T>	reconfigure()
boolean	remove(java.lang.Object other)
boolean	removeAll(@NotNull java.util.Collection<?> objects)
T	requireNonNull()
boolean	retainAll(@NotNull java.util.Collection<?> keep)
static <T> Span<T>	singleton(T it)
int	size()
void	sort(java.util.Comparator<T> comparator)
java.util.stream.Stream<T>	stream()
@NotNull java.lang.Object[]	toArray()
<R> @NotNull R[]	toArray(@NotNull R[] dummy)
java.lang.String	toString()
java.util.List<T>	unwrap()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.comroid.mutatio.pipe.Pipeable

pump, pump

Methods inherited from interface org.comroid.mutatio.ref.Reference

into, invocable, isNull, orElse, orElseGet, process, provider, requireNonNull, test, wrap

Methods inherited from interface org.comroid.mutatio.ref.ReferenceIndex

get, requireNonNull, requireNonNull, subset, subset, wrap

Methods inherited from interface org.comroid.api.SelfDeclared

self

Methods inherited from interface org.comroid.api.Specifiable

as, as, isType

Field Detail

UNFIXED_SIZE

public static final int UNFIXED_SIZE

See Also:

Constant Field Values

DEFAULT_MODIFY_POLICY

public static final Span.DefaultModifyPolicy DEFAULT_MODIFY_POLICY

Constructor Detail

Span

public Span()

Span

public Span(int fixedCapacity)

Span

public Span(ReferenceIndex<T> referenceIndex,
            ModifyPolicy modifyPolicy)

Span

public Span(ReferenceIndex<? extends T> data,
            ModifyPolicy modifyPolicy,
            boolean fixedSize)

Span

protected Span(ReferenceIndex<? extends T> data,
               int fixedCapacity,
               ModifyPolicy modifyPolicy)

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

isSingle

public final boolean isSingle()

isNotSingle

public final boolean isNotSingle()

isFixedSize

public final boolean isFixedSize()

collector

public static <T> java.util.stream.Collector<T,?,Span<T>> collector()

make

public static <T> Span.API<T> make()

empty

public static <T> Span<T> empty()

singleton

public static <T> Span<T> singleton(T it)

immutable

public static <T> Span<T> immutable(java.util.Collection<T> of)

immutable

@SafeVarargs
public static <T> Span<T> immutable(T... of)

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<T>

containsAll

public boolean containsAll(@NotNull
                           @NotNull java.util.Collection<?> objects)

Specified by:

containsAll in interface java.util.Collection<T>

addAll

public boolean addAll(@NotNull
                      @NotNull java.util.Collection<? extends T> objects)

Specified by:

addAll in interface java.util.Collection<T>

removeAll

public boolean removeAll(@NotNull
                         @NotNull java.util.Collection<?> objects)

Specified by:

removeAll in interface java.util.Collection<T>

retainAll

public boolean retainAll(@NotNull
                         @NotNull java.util.Collection<?> keep)

Specified by:

retainAll in interface java.util.Collection<T>

unwrap

public java.util.List<T> unwrap()

Specified by:

unwrap in interface ReferenceIndex<T>

size

@Contract
public final int size()

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface ReferenceIndex<T>

iterator

@NotNull
public final @NotNull Span.Iterator iterator()

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.lang.Iterable<T>

toArray

@NotNull
public final @NotNull java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T>

toArray

@NotNull
public final <R> @NotNull R[] toArray(@NotNull
                                      @NotNull R[] dummy)

Specified by:

toArray in interface java.util.Collection<T>

add

public final boolean add(T it)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface ReferenceIndex<T>

remove

public final boolean remove(java.lang.Object other)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface ReferenceIndex<T>

clear

public final void clear()

Description copied from interface: ReferenceIndex

Deletes all elements

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface ReferenceIndex<T>

stream

public java.util.stream.Stream<T> stream()

Specified by:

stream in interface java.util.Collection<T>

Specified by:

stream in interface Reference<T>

Specified by:

stream in interface ReferenceIndex<T>

pipe

public Pipe<?,T> pipe()

Specified by:

pipe in interface Pipeable<T>

Specified by:

pipe in interface ReferenceIndex<T>

getReference

public Reference<T> getReference(int index)

Specified by:

getReference in interface ReferenceIndex<T>

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

get

@Nullable
public final T get()

Specified by:

get in interface Reference<T>

Specified by:

get in interface java.util.function.Supplier<T>

requireNonNull

@NotNull
public T requireNonNull()
                 throws java.lang.NullPointerException

Specified by:

requireNonNull in interface Reference<T>

Throws:

java.lang.NullPointerException

range

public Span<T> range(int startIncl,
                     int endExcl)

sort

@Contract(mutates="this")
public void sort(java.util.Comparator<T> comparator)

cleanup

@Contract(mutates="this")
public final void cleanup()

reconfigure

@Contract("-> new")
public final Span.API<T> reconfigure()

into

public final <C extends java.util.Collection<T>> C into(java.util.function.Supplier<C> collectionSupplier)