com.bluegosling.tuples

Interface Tuple.Ops1<A>

All Superinterfaces:

Iterable<Object>, Tuple

All Known Subinterfaces:

Tuple.Ops2<A,B>, Tuple.Ops3<A,B,C>, Tuple.Ops4<A,B,C,D>, Tuple.Ops5<A,B,C,D,E>

All Known Implementing Classes:

NTuple, Pair, Quadruple, Quintuple, Single, Triple

Enclosing interface:

Tuple

public static interface Tuple.Ops1<A>
extends Tuple

Operations supported by tuples that have at least one element.

Nested Class Summary

Nested classes/interfaces inherited from interface com.bluegosling.tuples.Tuple

Tuple.Ops1<A>, Tuple.Ops2<A,B>, Tuple.Ops3<A,B,C>, Tuple.Ops4<A,B,C,D>, Tuple.Ops5<A,B,C,D,E>

Method Summary

Modifier and Type	Method and Description
<T> Tuple.Ops2<A,?>	add(T t) Adds a new item to this tuple.
A	getFirst() Retrieves the first item in the tuple.
<T> Tuple.Ops2<T,A>	insertFirst(T t) Adds an item into the first position of this tuple.
<T> Tuple.Ops2<A,T>	insertSecond(T t) Inserts an item into the second position of this tuple.
Tuple	removeFirst() Removes the first item from the tuple.
<T> Tuple.Ops1<T>	setFirst(T t) Sets the first item in the tuple.
<T> Tuple.Ops1<T>	transformAll(Function<Object,? extends T> function) Transforms every item in this tuple by applying the specified function to each one.
<T> Tuple.Ops1<T>	transformFirst(Function<? super A,? extends T> function) Transforms the first item in the tuple using the specified function.

Methods inherited from interface com.bluegosling.tuples.Tuple

asList, contains, equals, hashCode, isEmpty, size, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getFirst

A getFirst()

Retrieves the first item in the tuple.

Returns:

the first item in the tuple

setFirst

<T> Tuple.Ops1<T> setFirst(T t)

Sets the first item in the tuple. Since tuples are immutable, this returns a new tuple with the first item changed.

Parameters:

t - the new item

Returns:

a new tuple with the first item set to the specified new item

removeFirst

Tuple removeFirst()

Removes the first item from the tuple. Since tuples are immutable, this returns a new tuple with one less item.

Returns:

a new tuple with the same items as this tuple except that the first item is removed

add

<T> Tuple.Ops2<A,?> add(T t)

Description copied from interface: Tuple

Adds a new item to this tuple. The item will be appended and thus ordered last in the new tuple. Since tuples are immutable, a new tuple is returned with the same items as this tuple but with the specified item added to the end.

Specified by:

add in interface Tuple

Parameters:

t - the item to add

Returns:

a new tuple that is the specified item appended to this tuple

insertFirst

<T> Tuple.Ops2<T,A> insertFirst(T t)

Description copied from interface: Tuple

Adds an item into the first position of this tuple. Existing items are shifted over so the first item in this tuple is the second item in the returned tuple. Since tuples are immutable, a new tuple is returned with the same items as this tuple but with the specified item inserted as the first item.

Specified by:

insertFirst in interface Tuple

Parameters:

t - the item to insert

Returns:

a new tuple that is the specified item followed by the items in this tuple

insertSecond

<T> Tuple.Ops2<A,T> insertSecond(T t)

Inserts an item into the second position of this tuple. Since tuples are immutable, this returns a new tuple with one more item.

If this tuple has only one item then this is the same as calling add(Object). Otherwise, this will insert an item after the first item but before the second.

Parameters:

t - the new item

Returns:

a new tuple with the same items as this tuple except the specified new item is inserted as the second item in the tuple

transformAll

<T> Tuple.Ops1<T> transformAll(Function<Object,? extends T> function)

Description copied from interface: Tuple

Transforms every item in this tuple by applying the specified function to each one. Since tuples are immutable, a new tuple is returned. The returned tuple will have the same number of items as this tuple.

Specified by:

transformAll in interface Tuple

Parameters:

function - the function to apply

Returns:

a new tuple that is the result of applying the specified function to all elements of this tuple

transformFirst

<T> Tuple.Ops1<T> transformFirst(Function<? super A,? extends T> function)

Transforms the first item in the tuple using the specified function. Other items in the tuple are unchanged. Since tuples are immutable, this returns a new tuple.

Parameters:

function - the function to apply

Returns:

a new tuple with the first item set to the result of applying the specified function to the first item in this tuple