net.markenwerk.commons.collections.sequences

Class AbstractSequence<Payload>

java.lang.Object

net.markenwerk.commons.collections.sources.AbstractSource<Payload>

net.markenwerk.commons.collections.sources.AbstractIndexedSource<Payload>

net.markenwerk.commons.collections.sequences.AbstractSequence<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>, Sequence<Payload>, IndexedSource<Payload>, Source<Payload>, BidirectionalIterable<Payload>, ProtectedBidirectionalIterable<Payload>, ProtectedIterable<Payload>

Direct Known Subclasses:

AbstractListSequence

public abstract class AbstractSequence<Payload>
extends AbstractIndexedSource<Payload>
implements Sequence<Payload>

A AbstractSequence is an abstract base implementation of a Sequence.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
AbstractSequence(Nullity nullity) Creates a new AbstractSequence.

Method Summary

Modifier and Type	Method and Description
Sequence<Payload>	append(Payload payload) Appends the given payload value.
Sequence<Payload>	appendAll(Iterable<? extends Payload> payloads) Appends the given payload values.
Sequence<Payload>	appendAll(Payload... payloads) Appends the given payload values.
Source<Payload>	clear() Removes all payload values.
protected abstract Source<Payload>	doClear() Removes all payload values.
protected abstract void	doInsert(int index, Payload payload) Inserts the given payload value as the new first value.
protected abstract Payload	doRemove(int index) Removes the payload value at the given index.
protected abstract Source<Payload>	doRemoveAll(Predicate<? super Payload> predicate, boolean satisfying) Removes the payload values that satisfy the given Predicate.
protected abstract Payload	doReplace(int index, Payload replacement) Replaces the payload value at the given index with the given replacement payload value.
boolean	equals(Object object) Compares the given object with this Sequence for equality.
Nullity	getNullity() Returns the Nullity this AbstractSequence has been created with.
int	hashCode() Returns the hash code of this Sequence.
Sequence<Payload>	insert(int index, Payload payload) Inserts the given payload value at the given index.
Sequence<Payload>	insertAll(int index, Iterable<? extends Payload> payloads) Inserts the given payload values starting at the given index.
Sequence<Payload>	insertAll(int index, Payload... payloads) Inserts the given payload values starting at the given index.
protected void	onInserted(Payload payload) Called after the given payload value has been inserted.
protected void	onRemoved(Payload payload) Called after the given payload value has been removed.
protected void	onRemoved(Source<Payload> payloads) Called after the given payload values have been removed.
Sequence<Payload>	prepend(Payload payload) Prepends the given payload value.
Sequence<Payload>	prependAll(Iterable<? extends Payload> payloads) Prepends the given payload values.
Sequence<Payload>	prependAll(Payload... payloads) Prepends the given payload values.
Payload	remove(int index) Removes the payload value at the given index.
Source<Payload>	removeAll(Payload reference) Removes all occurrences, by equality, of the given reference payload value.
Source<Payload>	removeAllMatches(Predicate<? super Payload> predicate) Removes the payload values that satisfy the given Predicate.
Payload	removeFirst() Removes the first payload value.
Optional<Payload>	removeFirst(Payload reference) Removes the first occurrence, by equality, of the given reference payload value.
Optional<Payload>	removeFirstMatch(Predicate<? super Payload> predicate) Removes the first payload value that satisfies the given Predicate
Payload	removeLast() Removes the last payload value.
Optional<Payload>	removeLast(Payload reference) Removes the last occurrence, by equality, of the given payload value.
Optional<Payload>	removeLastMatch(Predicate<? super Payload> predicate) Removes the last payload value that satisfies the given Predicate
Payload	replace(int index, Payload replacement) Replaces the payload value at the given index with the given replacement payload value.
Source<Payload>	replaceAll(Payload reference, Provider<? extends Payload> provider) Replaces all occurrences of the the given reference payload value with payload values yielded by the given Provider.
Source<Payload>	replaceAllMatches(Predicate<? super Payload> predicate, Provider<? extends Payload> provider) Replaces all payload values that satisfy the given Predicate with payload values yielded by the given Provider.
Payload	replaceFirst(Payload replacement) Replaces the first payload value with the given replacement payload value.
Optional<Payload>	replaceFirst(Payload reference, Payload replacement) Replaces the first occurrence of the given reference payload value with the given replacement payload value.
Optional<Payload>	replaceFirstMatch(Predicate<? super Payload> predicate, Payload replacement) Replaces the first payload value that satisfy the given Predicate with the given replacement payload value.
Payload	replaceLast(Payload replacement) Replaces the last payload value with the given replacement payload value.
Optional<Payload>	replaceLast(Payload reference, Payload replacement) Replaces last occurrence of the the given reference payload value with the given replacement payload value.
Optional<Payload>	replaceLastMatch(Predicate<? super Payload> predicate, Payload replacement) Replaces the last payload value that satisfy the given Predicate with the given replacement payload value.
Source<Payload>	retainAll(Payload reference) Removes all but the given payload value.
Source<Payload>	retainAllMatches(Predicate<? super Payload> predicate) Removes all but the payload values that satisfy the given Predicate.

Methods inherited from class net.markenwerk.commons.collections.sources.AbstractIndexedSource

doGet, doGetFirst, doIterator, firstIndexOf, firstIndexOfMatch, get, getLast, getLast, getLastMatch, isFirst, isLast, iterator, iterator, lastIndexOf, lastIndexOfMatch

Methods inherited from class net.markenwerk.commons.collections.sources.AbstractSource

contains, containsAll, containsAll, containsMatch, createPredicate, firstIndexOf, getAll, getAllMatches, getFirst, getFirst, getFirstMatch, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.markenwerk.commons.collections.sources.IndexedSource

firstIndexOf, firstIndexOfMatch, get, getFirst, getFirst, getFirstMatch, getLast, getLast, getLastMatch, isFirst, isLast, iterator, lastIndexOf, lastIndexOfMatch

Methods inherited from interface net.markenwerk.commons.collections.sources.Source

contains, containsAll, containsAll, containsMatch, getAll, getAllMatches, isEmpty, size

Methods inherited from interface net.markenwerk.commons.iterables.ProtectedIterable

iterator

Methods inherited from interface net.markenwerk.commons.iterables.ProtectedBidirectionalIterable

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractSequence

public AbstractSequence(Nullity nullity)
                 throws IllegalArgumentException

Creates a new AbstractSequence.

Parameters:

nullity - The Nullity to be used.

Throws:

IllegalArgumentException - If the given Nullity is null.

Method Detail

getNullity

public final Nullity getNullity()

Returns the Nullity this AbstractSequence has been created with.

Returns:

The Nullity.

insert

public final Sequence<Payload> insert(int index,
                                      Payload payload)
                               throws IllegalArgumentException

Description copied from interface: Sequence

Inserts the given payload value at the given index.

Specified by:

insert in interface Sequence<Payload>

Parameters:

index - The index to be used.

payload - The payload value to be inserted.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given payload value is null and this Sequence doesn't allow a null to be added.

insertAll

public final Sequence<Payload> insertAll(int index,
                                         Payload... payloads)
                                  throws IllegalArgumentException,
                                         IllegalStateException

Description copied from interface: Sequence

Inserts the given payload values starting at the given index.

Specified by:

insertAll in interface Sequence<Payload>

Parameters:

index - The index to be used.

payloads - The array of payload values to be inserted.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given array of payload values is null or if any of the given payload values is null and this Sequence doesn't allow a null to be added.

IllegalStateException

insertAll

public final Sequence<Payload> insertAll(int index,
                                         Iterable<? extends Payload> payloads)
                                  throws IllegalArgumentException,
                                         IllegalStateException

Description copied from interface: Sequence

Inserts the given payload values starting at the given index.

Specified by:

insertAll in interface Sequence<Payload>

Parameters:

index - The index to be used.

payloads - The Iterable of payload values to be inserted.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given Iterable of payload values is null or if any of the given payload values is null and this Sequence doesn't allow a null to be added.

IllegalStateException

doInsert

protected abstract void doInsert(int index,
                                 Payload payload)

Inserts the given payload value as the new first value.

Parameters:

index - The index to be used.

payload - The payload value to be inserted, which is guaranteed to be not null, unless the Nullity of this Sequence is Nullity.ALLOW.

onInserted

protected void onInserted(Payload payload)

Called after the given payload value has been inserted.

Parameters:

payload - The inserted payload value, which is guaranteed to be not null, unless the Nullity of this Sequence is Nullity.ALLOW.

prepend

public final Sequence<Payload> prepend(Payload payload)
                                throws IllegalArgumentException

Description copied from interface: Sequence

Prepends the given payload value.

Specified by:

prepend in interface Sequence<Payload>

Parameters:

payload - The payload value to be prepended.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given payload value is null and this Sequence doesn't allow a null to be added.

prependAll

public final Sequence<Payload> prependAll(Payload... payloads)
                                   throws IllegalArgumentException

Description copied from interface: Sequence

Prepends the given payload values.

Specified by:

prependAll in interface Sequence<Payload>

Parameters:

payloads - The array of payload values to be inserted.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given array of payload values is null or if any of the given payload values is null and this Sequence doesn't allow a null to be added.

prependAll

public final Sequence<Payload> prependAll(Iterable<? extends Payload> payloads)
                                   throws IllegalArgumentException

Description copied from interface: Sequence

Prepends the given payload values.

Specified by:

prependAll in interface Sequence<Payload>

Parameters:

payloads - The Iterable of payload values to be inserted.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given Iterable of payload values is null or if any of the given payload values is null and this Sequence doesn't allow a null to be added.

append

public final Sequence<Payload> append(Payload payload)
                               throws IllegalArgumentException

Description copied from interface: Sequence

Appends the given payload value.

Specified by:

append in interface Sequence<Payload>

Parameters:

payload - The payload value to be appended.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given payload value is null and this Sequence doesn't allow a null to be added.

appendAll

public final Sequence<Payload> appendAll(Payload... payloads)
                                  throws IllegalArgumentException

Description copied from interface: Sequence

Appends the given payload values.

Specified by:

appendAll in interface Sequence<Payload>

Parameters:

payloads - The array of payload values to be appended.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given array of payload values is null or if any of the given payload values is null and this Sequence doesn't allow a null to be added.

appendAll

public final Sequence<Payload> appendAll(Iterable<? extends Payload> payloads)
                                  throws IllegalArgumentException

Description copied from interface: Sequence

Appends the given payload values.

Specified by:

appendAll in interface Sequence<Payload>

Parameters:

payloads - The Iterable of payload values to be appended.

Returns:

This Sequence.

Throws:

IllegalArgumentException - If the given Iterable of payload values is null or if any of the given payload values is null and this Sequence doesn't allow a null to be added.

remove

public final Payload remove(int index)
                     throws IndexOutOfBoundsException

Description copied from interface: Sequence

Removes the payload value at the given index.

Specified by:

remove in interface Sequence<Payload>

Parameters:

index - The index to be used.

Returns:

The payload value.

Throws:

IndexOutOfBoundsException - If the given index is negative or if the given index is larger or equal to the size of this Sequence.

doRemove

protected abstract Payload doRemove(int index)

Removes the payload value at the given index.

Parameters:

index - The index to be used which is guaranteed to be not negative and not larger then or equal to the size of this AbstractSequence.

Returns:

The payload value.

onRemoved

protected void onRemoved(Payload payload)

Called after the given payload value has been removed.

Parameters:

payload - The removed payload value, which is guaranteed to be not null, unless the Nullity of this Sequence is Nullity.ALLOW.

onRemoved

protected void onRemoved(Source<Payload> payloads)

Called after the given payload values have been removed.

Parameters:

payloads - The removed payload values, which are guaranteed to be not null, unless the Nullity of this Sequence is Nullity.ALLOW.

removeFirst

public final Payload removeFirst()
                          throws NoSuchElementException

Description copied from interface: Sequence

Removes the first payload value.

Specified by:

removeFirst in interface Sequence<Payload>

Returns:

The payload value.

Throws:

NoSuchElementException - If this Sequence is empty.

removeFirst

public final Optional<Payload> removeFirst(Payload reference)
                                    throws IllegalArgumentException

Description copied from interface: Sequence

Removes the first occurrence, by equality, of the given reference payload value.

Specified by:

removeFirst in interface Sequence<Payload>

Parameters:

reference - The reference payload to be removed.

Returns:

An Optional yielding the removed payload value.

Throws:

IllegalArgumentException

removeFirstMatch

public final Optional<Payload> removeFirstMatch(Predicate<? super Payload> predicate)
                                         throws IllegalArgumentException

Description copied from interface: Sequence

Removes the first payload value that satisfies the given Predicate

Specified by:

removeFirstMatch in interface Sequence<Payload>

Parameters:

predicate - The Predicate to be used.

Returns:

An Optional yielding the removed payload value.

Throws:

IllegalArgumentException - If the given predicate is null.

removeLast

public final Payload removeLast()
                         throws NoSuchElementException

Description copied from interface: Sequence

Removes the last payload value.

Specified by:

removeLast in interface Sequence<Payload>

Returns:

The payload value.

Throws:

NoSuchElementException - If this Sequence is empty.

removeLast

public final Optional<Payload> removeLast(Payload reference)
                                   throws IllegalArgumentException

Description copied from interface: Sequence

Removes the last occurrence, by equality, of the given payload value.

Specified by:

removeLast in interface Sequence<Payload>

Parameters:

reference - The reference payload to be removed.

Returns:

An Optional yielding the removed payload value.

Throws:

IllegalArgumentException

removeLastMatch

public final Optional<Payload> removeLastMatch(Predicate<? super Payload> predicate)
                                        throws IllegalArgumentException

Description copied from interface: Sequence

Removes the last payload value that satisfies the given Predicate

Specified by:

removeLastMatch in interface Sequence<Payload>

Parameters:

predicate - The Predicate to be used.

Returns:

An Optional yielding the removed payload value.

Throws:

IllegalArgumentException - If the given predicate is null.

removeAll

public final Source<Payload> removeAll(Payload reference)

Description copied from interface: Sequence

Removes all occurrences, by equality, of the given reference payload value.

Specified by:

removeAll in interface Sequence<Payload>

Parameters:

reference - The reference payload to be removed.

Returns:

A Source yielding the removed payload values.

removeAllMatches

public final Source<Payload> removeAllMatches(Predicate<? super Payload> predicate)
                                       throws IllegalArgumentException

Description copied from interface: Sequence

Removes the payload values that satisfy the given Predicate.

Specified by:

removeAllMatches in interface Sequence<Payload>

Parameters:

predicate - The Predicate to be used.

Returns:

A Source yielding the removed payload values.

Throws:

IllegalArgumentException - If the given Predicate is null.

doRemoveAll

protected abstract Source<Payload> doRemoveAll(Predicate<? super Payload> predicate,
                                               boolean satisfying)

Removes the payload values that satisfy the given Predicate.

Parameters:

predicate - The Predicate to be used, which is guaranteed to be not null.

satisfying - Whether the Predicate must be satisfied or not.

Returns:

A Source yielding the removed payload values.}.

retainAll

public final Source<Payload> retainAll(Payload reference)

Description copied from interface: Sequence

Removes all but the given payload value.

Specified by:

retainAll in interface Sequence<Payload>

Parameters:

reference - The reference payload values to be retained.

Returns:

A Source yielding the removed payload values.

retainAllMatches

public final Source<Payload> retainAllMatches(Predicate<? super Payload> predicate)
                                       throws IllegalArgumentException

Description copied from interface: Sequence

Removes all but the payload values that satisfy the given Predicate.

Specified by:

retainAllMatches in interface Sequence<Payload>

Parameters:

predicate - The Predicate to be used.

Returns:

A Source yielding the removed payload values.

Throws:

IllegalArgumentException - If the given Predicate is null.

clear

public final Source<Payload> clear()

Description copied from interface: Sequence

Removes all payload values.

Specified by:

clear in interface Sequence<Payload>

Returns:

A Source yielding the removed payload values.

doClear

protected abstract Source<Payload> doClear()

Removes all payload values.

Returns:

A Source yielding the removed payload values.

replace

public final Payload replace(int index,
                             Payload replacement)
                      throws IllegalArgumentException,
                             IndexOutOfBoundsException

Description copied from interface: Sequence

Replaces the payload value at the given index with the given replacement payload value.

Specified by:

replace in interface Sequence<Payload>

Parameters:

index - The index to be used.

replacement - The replacement payload value to be used.

Returns:

The replaced payload value.

Throws:

IllegalArgumentException - If the given replacement payload value is null and this IndexedSource doesn't allow a null to be added.

IndexOutOfBoundsException - If the given index is negative or if the given index is larger or equal to the size of this IndexedSource.

doReplace

protected abstract Payload doReplace(int index,
                                     Payload replacement)

Replaces the payload value at the given index with the given replacement payload value.

Parameters:

index - The index to be used which is guaranteed to be not negative and not larger then or equal to the size of this AbstractSequence.

replacement - The replacement payload value to be used.

Returns:

The replaced payload value.

replaceFirst

public final Payload replaceFirst(Payload replacement)
                           throws IllegalArgumentException,
                                  NoSuchElementException

Description copied from interface: Sequence

Replaces the first payload value with the given replacement payload value.

Specified by:

replaceFirst in interface Sequence<Payload>

Parameters:

replacement - The replacement payload value to be used.

Returns:

The replaced payload value.

Throws:

IllegalArgumentException - If the given replacement payload value is null and this IndexedSource doesn't allow a null to be added.

NoSuchElementException - If this IndexedSource is empty.

replaceFirst

public final Optional<Payload> replaceFirst(Payload reference,
                                            Payload replacement)
                                     throws IllegalArgumentException

Description copied from interface: Sequence

Replaces the first occurrence of the given reference payload value with the given replacement payload value.

Specified by:

replaceFirst in interface Sequence<Payload>

Parameters:

reference - The reference payload value to be used.

replacement - The replacement payload to be used.

Returns:

An Optional yielding the removed payload value, if any.

Throws:

IllegalArgumentException - If the given replacement payload value is null and this IndexedSource doesn't allow a null to be added.

replaceFirstMatch

public final Optional<Payload> replaceFirstMatch(Predicate<? super Payload> predicate,
                                                 Payload replacement)
                                          throws IllegalArgumentException

Description copied from interface: Sequence

Replaces the first payload value that satisfy the given Predicate with the given replacement payload value.

Specified by:

replaceFirstMatch in interface Sequence<Payload>

Parameters:

predicate - The Predicate to be used.

replacement - The replacement payload to be used.

Returns:

An Optional yielding the removed payload value, if any.

Throws:

IllegalArgumentException - If the give Predicate is null or if the given replacement payload value is null and this IndexedSource doesn't allow a null to be added.

replaceLast

public final Payload replaceLast(Payload replacement)
                          throws IllegalArgumentException,
                                 NoSuchElementException

Description copied from interface: Sequence

Replaces the last payload value with the given replacement payload value.

Specified by:

replaceLast in interface Sequence<Payload>

Parameters:

replacement - The replacement payload value to be used.

Returns:

The replaced payload value.

Throws:

IllegalArgumentException - If the given replacement payload value is null and this IndexedSource doesn't allow a null to be added.

NoSuchElementException - If this IndexedSource is empty.

replaceLast

public final Optional<Payload> replaceLast(Payload reference,
                                           Payload replacement)
                                    throws IllegalArgumentException

Description copied from interface: Sequence

Replaces last occurrence of the the given reference payload value with the given replacement payload value.

Specified by:

replaceLast in interface Sequence<Payload>

Parameters:

reference - The replacement reference payload value to be used.

replacement - The payload to be used.

Returns:

An Optional yielding the removed payload value, if any.

Throws:

IllegalArgumentException - If the given replacement payload value is null and this IndexedSource doesn't allow a null to be added.

replaceLastMatch

public Optional<Payload> replaceLastMatch(Predicate<? super Payload> predicate,
                                          Payload replacement)
                                   throws IllegalArgumentException

Description copied from interface: Sequence

Replaces the last payload value that satisfy the given Predicate with the given replacement payload value.

Specified by:

replaceLastMatch in interface Sequence<Payload>

Parameters:

predicate - The Predicate to be used.

replacement - The replacement payload to be used.

Returns:

An Optional yielding the removed payload value, if any.

Throws:

IllegalArgumentException - If the give Predicate is null or if the given replacement payload value is null and this IndexedSource doesn't allow a null to be added.

replaceAll

public final Source<Payload> replaceAll(Payload reference,
                                        Provider<? extends Payload> provider)
                                 throws IllegalArgumentException,
                                        ProvisioningException

Description copied from interface: Sequence

Replaces all occurrences of the the given reference payload value with payload values yielded by the given Provider.

Specified by:

replaceAll in interface Sequence<Payload>

Parameters:

reference - The reference payload value to be used.

provider - The Provider to be used.

Returns:

A Source yielding the replaced payload values.

Throws:

IllegalArgumentException - If the given Provider is null.

ProvisioningException - If the given Provider yields null and this IndexedSource doesn't allow a null to be added.

replaceAllMatches

public final Source<Payload> replaceAllMatches(Predicate<? super Payload> predicate,
                                               Provider<? extends Payload> provider)
                                        throws IllegalArgumentException,
                                               ProvisioningException

Description copied from interface: Sequence

Replaces all payload values that satisfy the given Predicate with payload values yielded by the given Provider.

Specified by:

replaceAllMatches in interface Sequence<Payload>

Parameters:

predicate - The Predicate to be used.

provider - The Provider to be used.

Returns:

A Source yielding the replaced payload values.

Throws:

IllegalArgumentException - If the give Predicate is null or if the given Provider is null.

ProvisioningException - If the given Provider yields null and this IndexedSource doesn't allow a null to be added.

hashCode

public final int hashCode()

Description copied from interface: Sequence

Returns the hash code of this Sequence.

The hash code of a Sequence is defined to be the result of the following calculation:

 int hashCode = 1;
 Iterator<Payload> iterator = sequence.iterator();
 while (iterator.hasNext()) {
        Payload payload = iterator.next();
        hashCode = 31 * hashCode + (null == payload ? 0 : payload.hashCode());
 }
 

Specified by:

hashCode in interface Sequence<Payload>

Overrides:

hashCode in class Object

Returns:

The hash code of this Sequence.

equals

public final boolean equals(Object object)

Description copied from interface: Sequence

Compares the given object with this Sequence for equality.

Returns true if and only if the given object is also a Sequence, both Sequences have the same size, and all corresponding pairs of elements in the two Sequences are equal.

Specified by:

equals in interface Sequence<Payload>

Overrides:

equals in class Object

Parameters:

object - The object to be used.

Returns:

If the given object is equal to this Sequence.