org.kocakosm.pitaya.collection

Class ImmutableList.Builder<E>

java.lang.Object

org.kocakosm.pitaya.collection.ImmutableList.Builder<E>

Type Parameters:

E - the type of the List's elements.

Enclosing class:

ImmutableList<E>

public static final class ImmutableList.Builder<E>
extends Object

ImmutableList builder. Not thread-safe.

Constructor Summary

Constructors

Constructor and Description
ImmutableList.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
ImmutableList.Builder<E>	add(E... values) Adds the given values to the List being built.
ImmutableList.Builder<E>	add(Iterable<? extends E> values) Adds all the values contained in the given Iterable to the List being built.
ImmutableList.Builder<E>	add(Iterator<? extends E> values) Adds all the values contained in the given Iterator to the List being built.
List<E>	build() Finalizes the creation of the ImmutableList.
ImmutableList.Builder<E>	reverse() Reverses the order of the elements currently in the List being built.
ImmutableList.Builder<E>	rotate(int n) Rotates the elements currently in the List being built by the specified distance.
ImmutableList.Builder<E>	shuffle() Randomly permutes the elements currently in the List being built using a default source of randomness.
ImmutableList.Builder<E>	shuffle(Random random) Randomly permutes the elements currently in the List being built using the specified source of randomness.
ImmutableList.Builder<E>	sort() Sorts the elements currently in the List being built into ascending order, according to the natural ordering of its elements (all elements in this builder must implement the Comparable interface).
ImmutableList.Builder<E>	sort(Comparator<? super E> c) Sorts the elements currently in the List being built into ascending order, according to the order induced by the given Comparator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImmutableList.Builder

public ImmutableList.Builder()

Method Detail

add

public ImmutableList.Builder<E> add(E... values)

Adds the given values to the List being built.

Parameters:

values - the values to add.

Returns:

this object.

Throws:

NullPointerException - if values is null.

add

public ImmutableList.Builder<E> add(Iterable<? extends E> values)

Adds all the values contained in the given Iterable to the List being built.

Parameters:

values - the values to add.

Returns:

this object.

Throws:

NullPointerException - if values is null.

add

public ImmutableList.Builder<E> add(Iterator<? extends E> values)

Adds all the values contained in the given Iterator to the List being built.

Parameters:

values - the values to add.

Returns:

this object.

Throws:

NullPointerException - if values is null.

sort

public ImmutableList.Builder<E> sort()

Sorts the elements currently in the List being built into ascending order, according to the natural ordering of its elements (all elements in this builder must implement the Comparable interface).

Returns:

this object.

Throws:

ClassCastException - if this builder contains elements that are not mutually comparable.

IllegalArgumentException - if the natural ordering of the elements in this builder is found to violate the Comparable contract.

sort

public ImmutableList.Builder<E> sort(Comparator<? super E> c)

Sorts the elements currently in the List being built into ascending order, according to the order induced by the given Comparator.

Parameters:

c - the Comparator to use.

Returns:

this object.

Throws:

ClassCastException - if this builder contains elements that are not mutually comparable using the specified Comparator.

IllegalArgumentException - if the comparator is found to violate the Comparator contract.

reverse

public ImmutableList.Builder<E> reverse()

Reverses the order of the elements currently in the List being built.

Returns:

this object.

rotate

public ImmutableList.Builder<E> rotate(int n)

Rotates the elements currently in the List being built by the specified distance.

Parameters:

n - the distance to rotate.

Returns:

this object.

shuffle

public ImmutableList.Builder<E> shuffle()

Randomly permutes the elements currently in the List being built using a default source of randomness. All permutations occur with approximately equal likelihood.

Returns:

this object.

shuffle

public ImmutableList.Builder<E> shuffle(Random random)

Randomly permutes the elements currently in the List being built using the specified source of randomness. All permutations occur with equal likelihood assuming that the source of randomness is fair.

Parameters:

random - the source of randomness to use.

Returns:

this object.

Throws:

NullPointerException - if random is null.

build

public List<E> build()

Finalizes the creation of the ImmutableList.

Returns:

an instance of ImmutableList.