org.mathIT.util

Class Tuple<T>

java.lang.Object

org.mathIT.util.Tuple<T>

Type Parameters:

T - type of stored elements

All Implemented Interfaces:

Serializable, Iterable<T>, Collection<T>

public final class Tuple<T>
extends Object
implements Collection<T>, Serializable

An implementation of Collection that stores n non-null objects and is not mutable. Tuples respect equals in the sense that two tuples are equal if they contain equal objects. Thus in partucular they may be used as indices or keys in maps.

Note that they do not protect from malevolent behavior: if one or another object in the tuple is mutable, then it can be changed.

Version:

1.0

Author:

Andreas de Vries

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Tuple(Collection<? extends T> elements) Creates a Tuple from the passed Collection.
Tuple(T[] elements) Creates a Tuple from the specified elements.
Tuple(T first, T second) Creates a Tuple from the specified elements.

Method Summary

Modifier and Type	Method and Description
boolean	add(T o) Since a tuple is not mutable, this method should not be invoked.
boolean	addAll(Collection<? extends T> c) Since a tuple is not mutable, this method should not be invoked.
void	clear() Since a tuple is not mutable, this method should not be invoked.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
T	getFirst() Returns the first element of this tuple.
T	getSecond() Returns the second element of this tuple.
int	hashCode()
boolean	isEmpty()
Iterator<T>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<S> S[]	toArray(S[] a)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Tuple

public Tuple(T[] elements)

Creates a Tuple from the specified elements.

Parameters:

elements - the elements in the Tuple

Throws:

IllegalArgumentException - if either argument is null or there are less than two elements

Tuple

public Tuple(Collection<? extends T> elements)

Creates a Tuple from the passed Collection.

Parameters:

elements - the elements of the new Tuple

Throws:

IllegalArgumentException - if the input collection is null, contains null values, or has < 2 elements.

Tuple

public Tuple(T first,
             T second)

Creates a Tuple from the specified elements.

Parameters:

first - the first element in the Tuple

second - the second element in the Tuple

Throws:

IllegalArgumentException - if either argument is null

Method Detail

getFirst

public T getFirst()

Returns the first element of this tuple.

Returns:

the first element of this tuple.

getSecond

public T getSecond()

Returns the second element of this tuple.

Returns:

the second element of this tuple.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

add

public boolean add(T o)

Since a tuple is not mutable, this method should not be invoked.

Specified by:

add in interface Collection<T>

Parameters:

o - an object

Returns:

true if and only if the operation was successful

Throws:

UnsupportedOperationException - if this method is invoked

addAll

public boolean addAll(Collection<? extends T> c)

Since a tuple is not mutable, this method should not be invoked.

Specified by:

addAll in interface Collection<T>

Parameters:

c - an object

Returns:

true if and only if the operation was successful

Throws:

UnsupportedOperationException - if this method is invoked

clear

public void clear()

Since a tuple is not mutable, this method should not be invoked.

Specified by:

clear in interface Collection<T>

Throws:

UnsupportedOperationException - if this method is invoked

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

size

public int size()

Specified by:

size in interface Collection<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

toArray

public <S> S[] toArray(S[] a)

Specified by:

toArray in interface Collection<T>