gololang

Class Tuple

java.lang.Object

gololang.Tuple

All Implemented Interfaces:

Iterable<Object>

public final class Tuple
extends Object
implements Iterable<Object>

Represents an tuple object.

A tuple essentially behaves like an immutable array. In Golo, tuples can be created as follows:

 # Short syntax
 let t1 = [1, 2, 3]

 # Complete collection literal syntax
 let t2 = tuple[1, 2, 3]
 

Constructor Summary

Constructors

Constructor and Description
Tuple(Object... values) Creates a new tuple from values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static Tuple	fromArray(Object[] values) Helper factory method.
Object	get(int index) Gets the element at a specified index.
int	hashCode()
boolean	isEmpty() Checks whether the tuple is empty or not.
Iterator<Object>	iterator() Creates an iterator over the tuple.
int	size() Gives the number of elements in this tuple.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Tuple

public Tuple(Object... values)

Creates a new tuple from values.

Parameters:

values - the tuple values.

Method Detail

fromArray

public static Tuple fromArray(Object[] values)

Helper factory method.

Parameters:

values - the values as an array.

Returns:

a tuple from the array values.

size

public int size()

Gives the number of elements in this tuple.

Returns:

the tuple size.

isEmpty

public boolean isEmpty()

Checks whether the tuple is empty or not.

Returns:

true if the tuple has no element, false otherwise.

get

public Object get(int index)

Gets the element at a specified index.

Parameters:

index - the element index.

Returns:

the element at index index.

Throws:

IndexOutOfBoundsException - if the specified index is not valid (negative value or above the size).

iterator

public Iterator<Object> iterator()

Creates an iterator over the tuple.

The iterator does not support removal.

Specified by:

iterator in interface Iterable<Object>

Returns:

an iterator.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object