public class Tuple<E>
extends AbstractList
implements Serializable, Cloneable, Comparable, RandomAccessRepresents a list of Objects.
| Type Params | Return Type | Name and description |
|---|---|---|
|
public Tuple<E> |
clone()Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:
will be true, and that the expression: will be true, but these are not absolute requirements.
While it is typically the case that:
will be true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by
|
|
public int |
compareTo(Tuple<E> other)Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure signum The implementor must also ensure that the relation is transitive:
Finally, the implementor must ensure that
|
|
public boolean |
equals(Object o)Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both
lists have the same size, and all corresponding pairs of elements in
the two lists are equal. (Two elements e1 and
e2 are equal if (e1==null ? e2==null :
e1.equals(e2)).) In other words, two lists are defined to be
equal if they contain the same elements in the same order.
|
|
public E |
get(int index)Returns the element at the specified position in this list.
|
|
public int |
hashCode()Returns the hash code value for this list.
|
|
public int |
size() |
|
public List<E> |
subList(int fromIndex, int toIndex)Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If
fromIndex and toIndex are equal, the returned list is
empty.) The returned list is backed by this list, so non-structural
changes in the returned list are reflected in this list, and vice-versa.
The returned list supports all of the optional list operations supported
by this list.This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list: indexOf and
lastIndexOf, and all of the algorithms in the
Collections class can be applied to a subList.The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)
|
|
public Tuple<E> |
subTuple(int fromIndex, int toIndex)Returns a tuple containing the specified range of elements. |
|
public E[] |
toArray()Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type is Object.
The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.
|
<T> |
public T[] |
toArray(T[] a)Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection. If this collection fits in the specified array with room to spare
(i.e., the array has more elements than this collection), the element
in the array immediately following the end of the collection is set to
If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
|
|
public static Tuple0 |
tuple()Construct a tuple of degree 0. |
<T1> |
public static Tuple1<T1> |
tuple(T1 v1)Construct a tuple of degree 1. |
<T1, T2> |
public static Tuple2<T1, T2> |
tuple(T1 v1, T2 v2)Construct a tuple of degree 2. |
<T1, T2, T3> |
public static Tuple3<T1, T2, T3> |
tuple(T1 v1, T2 v2, T3 v3)Construct a tuple of degree 3. |
<T1, T2, T3, T4> |
public static Tuple4<T1, T2, T3, T4> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4)Construct a tuple of degree 4. |
<T1, T2, T3, T4, T5> |
public static Tuple5<T1, T2, T3, T4, T5> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5)Construct a tuple of degree 5. |
<T1, T2, T3, T4, T5, T6> |
public static Tuple6<T1, T2, T3, T4, T5, T6> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6)Construct a tuple of degree 6. |
<T1, T2, T3, T4, T5, T6, T7> |
public static Tuple7<T1, T2, T3, T4, T5, T6, T7> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7)Construct a tuple of degree 7. |
<T1, T2, T3, T4, T5, T6, T7, T8> |
public static Tuple8<T1, T2, T3, T4, T5, T6, T7, T8> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8)Construct a tuple of degree 8. |
<T1, T2, T3, T4, T5, T6, T7, T8, T9> |
public static Tuple9<T1, T2, T3, T4, T5, T6, T7, T8, T9> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9)Construct a tuple of degree 9. |
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> |
public static Tuple10<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10)Construct a tuple of degree 10. |
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> |
public static Tuple11<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11)Construct a tuple of degree 11. |
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> |
public static Tuple12<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12)Construct a tuple of degree 12. |
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> |
public static Tuple13<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13)Construct a tuple of degree 13. |
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> |
public static Tuple14<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14)Construct a tuple of degree 14. |
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> |
public static Tuple15<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15)Construct a tuple of degree 15. |
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> |
public static Tuple16<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> |
tuple(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16)Construct a tuple of degree 16. |
| Methods inherited from class | Name |
|---|---|
class AbstractList |
add, add, addAll, addAll, clear, contains, containsAll, equals, forEach, get, getClass, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, notify, notifyAll, parallelStream, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, size, sort, spliterator, stream, subList, toArray, toArray, toArray, toString, wait, wait, wait |
Creates a tuple containing the supplied elements.
contents - the tuple elementsCreates a tuple from the supplied tuple.
tuple - the source tuple Creates and returns a copy of this object. The precise meaning
of "copy" may depend on the class of the object. The general
intent is that, for any object x, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
super.clone. If a class and all of its superclasses (except
Object) obey this convention, it will be the case that
x.clone().getClass() == x.getClass().
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by super.clone before returning it. Typically, this means
copying any mutable objects that comprise the internal "deep structure"
of the object being cloned and replacing the references to these
objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually
the case that no fields in the object returned by super.clone
need to be modified.
Cloneable interface. Subclasses
that override the clone method can also
throw this exception to indicate that an instance cannot
be cloned.clone for class Object performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable, then a
CloneNotSupportedException is thrown. Note that all arrays
are considered to implement the interface Cloneable and that
the return type of the clone method of an array type T[]
is T[] where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object does not itself implement the interface
Cloneable, so calling the clone method on an object
whose class is Object will result in throwing an
exception at run time.
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for
all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)
The implementor must also ensure that the relation is transitive:
(x.compareTo(y) > 0 && y.compareTo(z) > 0) implies
x.compareTo(z) > 0.
Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z))
== signum(y.compareTo(z)), for all z.
(x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any
class that implements the Comparable interface and violates
this condition should clearly indicate this fact. The recommended
language is "Note: this class has a natural ordering that is
inconsistent with equals."o - the object to be compared. Compares the specified object with this list for equality. Returns
true if and only if the specified object is also a list, both
lists have the same size, and all corresponding pairs of elements in
the two lists are equal. (Two elements e1 and
e2 are equal if (e1==null ? e2==null :
e1.equals(e2)).) In other words, two lists are defined to be
equal if they contain the same elements in the same order.
true; if not, it checks if the
specified object is a list. If not, it returns false; if so,
it iterates over both lists, comparing corresponding pairs of elements.
If any comparison returns false, this method returns
false. If either iterator runs out of elements before the
other it returns false (as the lists are of unequal length);
otherwise it returns true when the iterations complete.o - the object to be compared for equality with this listtrue if the specified object is equal to this listReturns the element at the specified position in this list.
index < 0 || index >= size())index < 0 || index >= size())index - index of the element to returnindex - index of the element to returnReturns the hash code value for this list.
Returns a view of the portion of this list between the specified
fromIndex, inclusive, and toIndex, exclusive. (If
fromIndex and toIndex are equal, the returned list is
empty.) The returned list is backed by this list, so non-structural
changes in the returned list are reflected in this list, and vice-versa.
The returned list supports all of the optional list operations supported
by this list.
This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:
list.subList(from, to).clear();
indexOf and
lastIndexOf, and all of the algorithms in the
Collections class can be applied to a subList.The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)
fromIndex < 0 || toIndex > size ||
fromIndex > toIndex)(fromIndex < 0 || toIndex > size)(fromIndex > toIndex)fromIndex - low endpoint (inclusive) of the subListtoIndex - high endpoint (exclusive) of the subListAbstractList. The subclass stores, in private fields, the
size of the subList (which can change over its lifetime), and the
expected modCount value of the backing list. There are two
variants of the subclass, one of which implements RandomAccess.
If this list implements RandomAccess the returned list will
be an instance of the subclass that implements RandomAccess.
The subclass's set(int, E), get(int),
add(int, E), remove(int), addAll(int,
Collection) and removeRange(int, int) methods all
delegate to the corresponding methods on the backing abstract list,
after bounds-checking the index and adjusting for the offset. The
addAll(Collection c) method merely returns addAll(size,
c).
The listIterator(int) method returns a "wrapper object"
over a list iterator on the backing list, which is created with the
corresponding method on the backing list. The iterator method
merely returns listIterator(), and the size method
merely returns the subclass's size field.
All methods first check to see if the actual modCount of
the backing list is equal to its expected value, and throw a
ConcurrentModificationException if it is not.
Returns a tuple containing the specified range of elements.
fromIndex - the start index, inclusivetoIndex - the end index, exclusive Returns an array containing all of the elements in this collection.
If this collection makes any guarantees as to what order its elements
are returned by its iterator, this method must return the elements in
the same order. The returned array's runtime component type is Object.
The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.
Object[].
Use toArray(Object[]) toArray(T[]) to reuse an existing
array, or use toArray(IntFunction) to control the runtime type
of the array.Object, containing all of the elements in this collection0.
The length of the returned array is equal to the number of elements
returned by the iterator, even if the size of this collection changes
during iteration, as might happen if the collection permits
concurrent modification during iteration. The size method is
called only as an optimization hint; the correct result is returned
even if the iterator returns a different number of elements.
This method is equivalent to:
List<E> list = new ArrayList<E>(size());
for (E e : this)
list.add(e);
return list.toArray();
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.
If this collection fits in the specified array with room to spare
(i.e., the array has more elements than this collection), the element
in the array immediately following the end of the collection is set to
null. (This is useful in determining the length of this
collection only if the caller knows that this collection does
not contain any null elements.)
If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
If this collection fits in the specified array with room to spare
(i.e., the array has more elements than this collection), the element
in the array immediately following the end of the collection is set to
null. (This is useful in determining the length of this
collection only if the caller knows that this collection does
not contain any null elements.)
If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
If this collection fits in the specified array with room to spare
(i.e., the array has more elements than this collection), the element
in the array immediately following the end of the collection is set to
null. (This is useful in determining the length of this
collection only if the caller knows that this collection does
not contain any null elements.)
If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
Object[],
or use toArray(IntFunction) to control the runtime type of
the array.
Suppose x is a collection known to contain only strings.
The following code can be used to dump the collection into a previously
allocated String array:
String[] y = new String[SIZE];
...
y = x.toArray(y);The return value is reassigned to the variable y, because a
new array will be allocated and returned if the collection x has
too many elements to fit into the existing array y.
Note that toArray(new Object[0]) is identical in function to
toArray().
Object[],
or use toArray(IntFunction) to control the runtime type of
the array.
Suppose x is a collection known to contain only strings.
The following code can be used to dump the collection into a previously
allocated String array:
String[] y = new String[SIZE];
...
y = x.toArray(y);The return value is reassigned to the variable y, because a
new array will be allocated and returned if the collection x has
too many elements to fit into the existing array y.
Note that toArray(new Object[0]) is identical in function to
toArray().
Object[],
or use toArray(IntFunction) to control the runtime type of
the array.
Suppose x is a collection known to contain only strings.
The following code can be used to dump the collection into a previously
allocated String array:
String[] y = new String[SIZE];
...
y = x.toArray(y);The return value is reassigned to the variable y, because a
new array will be allocated and returned if the collection x has
too many elements to fit into the existing array y.
Note that toArray(new Object[0]) is identical in function to
toArray().
T - the component type of the array to contain the collectionT - the component type of the array to contain the collectionT - the component type of the array to contain the collectiona - the array into which the elements of this collection are to be
stored, if it is big enough; otherwise, a new array of the same
runtime type is allocated for this purpose.a - the array into which the elements of this collection are to be
stored, if it is big enough; otherwise, a new array of the same
runtime type is allocated for this purpose.a - the array into which the elements of this collection are to be
stored, if it is big enough; otherwise, a new array of the same
runtime type is allocated for this purpose.0.
If the number of elements returned by the iterator is too large to
fit into the specified array, then the elements are returned in a
newly allocated array with length equal to the number of elements
returned by the iterator, even if the size of this collection
changes during iteration, as might happen if the collection permits
concurrent modification during iteration. The size method is
called only as an optimization hint; the correct result is returned
even if the iterator returns a different number of elements.
This method is equivalent to:
List<E> list = new ArrayList<E>(size());
for (E e : this)
list.add(e);
return list.toArray(a);
Construct a tuple of degree 0.
Construct a tuple of degree 3.
Construct a tuple of degree 4.
Construct a tuple of degree 5.
Construct a tuple of degree 6.
Construct a tuple of degree 7.
Construct a tuple of degree 8.
Construct a tuple of degree 9.
Construct a tuple of degree 10.
Construct a tuple of degree 11.
Construct a tuple of degree 12.
Construct a tuple of degree 13.
Construct a tuple of degree 14.
Construct a tuple of degree 15.
Construct a tuple of degree 16.
Copyright © 2003-2026 The Apache Software Foundation. All rights reserved.