Package org.eclipse.collections.impl.list.immutable

Class ImmutableDoubletonList<T>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<T>

org.eclipse.collections.impl.collection.immutable.AbstractImmutableCollection<T>

org.eclipse.collections.impl.list.immutable.AbstractImmutableList<T>

org.eclipse.collections.impl.list.immutable.ImmutableDoubletonList<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess, ImmutableCollection<T>, InternalIterable<T>, ImmutableList<T>, ListIterable<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>

final class ImmutableDoubletonList<T>
extends AbstractImmutableList<T>
implements java.io.Serializable, java.util.RandomAccess

This is a two element immutable List which is created by calling Immutable.newListWith(one, two) method.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.collections.impl.list.immutable.AbstractImmutableList

AbstractImmutableList.ImmutableSubList<T>

Field Summary

Fields

Modifier and Type	Field	Description
private T	element1
private T	element2
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
ImmutableDoubletonList(T obj1, T obj2)

Method Summary

Modifier and Type	Method	Description
boolean	contains(java.lang.Object obj)	Returns true if the iterable has an element which responds true to element.equals(object).
void	each(Procedure<? super T> procedure)	The procedure is executed for each element in the iterable.
T	get(int index)	Returns the item at the specified position in this list iterable.
T	getFirst()	Returns the first element of an iterable.
T	getLast()	Returns the last element of an iterable.
T	getOnly()	Returns the element if the iterable has exactly one element.
ImmutableList<T>	newWith(T newItem)	This method is similar to the with method in MutableCollection with the difference that a new copy of this collection with the element appended will be returned.
int	size()	Returns the number of items in this iterable.

Methods inherited from class org.eclipse.collections.impl.list.immutable.AbstractImmutableList

add, addAll, appendString, asParallel, asReversed, castToList, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, collectWith, corresponds, count, detectIndex, detectLastIndex, distinct, distinct, distinctBy, drop, dropWhile, equals, flatCollect, flatCollect, forEach, forEachWith, forEachWithIndex, forEachWithIndex, groupBy, groupBy, groupByEach, groupByEach, hashCode, indexOf, injectInto, injectInto, injectInto, injectInto, injectInto, iterator, lastIndexOf, listIterator, listIterator, max, max, maxBy, min, min, minBy, newMutable, newWithAll, newWithout, newWithoutAll, partition, partitionWhile, partitionWith, regularListEquals, reject, rejectWith, rejectWith, remove, replaceAll, select, selectInstancesOf, selectWith, selectWith, set, sort, subList, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, take, takeWhile, tap, toImmutable, toReversed, zip, zipWithIndex

Methods inherited from class org.eclipse.collections.impl.collection.immutable.AbstractImmutableCollection

add, addAll, castToCollection, clear, countBy, countByEach, countByWith, groupByUniqueKey, parallelStream, reduce, remove, removeAll, removeAllFrom, retainAll, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong, toArray, toArray

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, asLazy, collect, collectIf, containsAll, containsAllArguments, containsAllIterable, countWith, detect, detectOptional, detectWith, detectWithIfNone, detectWithOptional, forEach, groupByUniqueKey, into, isEmpty, noneSatisfy, noneSatisfyWith, reject, select, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.eclipse.collections.api.collection.ImmutableCollection

aggregateBy, aggregateInPlaceBy, castToCollection, countBy, countByEach, countByWith, groupByUniqueKey, parallelStream, reduceBy, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from interface org.eclipse.collections.api.list.ImmutableList

collectWithIndex, flatCollectWith, rejectWithIndex, selectWithIndex, toImmutableList

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach

Methods inherited from interface java.util.List

add, addAll, clear, containsAll, isEmpty, remove, removeAll, retainAll, spliterator, toArray, toArray

Methods inherited from interface org.eclipse.collections.api.list.ListIterable

binarySearch, binarySearch, forEachInBoth

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

collectWithIndex, getFirstOptional, getLastOptional, rejectWithIndex, selectWithIndex, toStack, zip, zipWithIndex

Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable

reverseForEach, reverseForEachWithIndex

Methods inherited from interface org.eclipse.collections.api.RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, groupByAndCollect, groupByUniqueKey, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceInPlace, reduceInPlace, reject, select, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

element1

private final T element1

element2

private final T element2

Constructor Detail

ImmutableDoubletonList

ImmutableDoubletonList(T obj1,
                       T obj2)

Method Detail

getFirst

public T getFirst()

Description copied from interface: RichIterable

Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

Specified by:

getFirst in interface ListIterable<T>

Specified by:

getFirst in interface OrderedIterable<T>

Specified by:

getFirst in interface RichIterable<T>

Overrides:

getFirst in class AbstractImmutableList<T>

getLast

public T getLast()

Description copied from interface: RichIterable

Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

Specified by:

getLast in interface ListIterable<T>

Specified by:

getLast in interface OrderedIterable<T>

Specified by:

getLast in interface RichIterable<T>

Overrides:

getLast in class AbstractImmutableList<T>

getOnly

public T getOnly()

Description copied from interface: RichIterable

Returns the element if the iterable has exactly one element. Otherwise, throw IllegalStateException.

Specified by:

getOnly in interface RichIterable<T>

Returns:

an element of an iterable.

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.List<T>

Specified by:

size in interface RichIterable<T>

each

public void each(Procedure<? super T> procedure)

Description copied from interface: RichIterable

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

 people.each(person -> LOGGER.info(person.getName()));
 

This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).

Specified by:

each in interface RichIterable<T>

See Also:

InternalIterable.forEach(Procedure), Iterable.forEach(java.util.function.Consumer)

get

public T get(int index)

Description copied from interface: ListIterable

Returns the item at the specified position in this list iterable.

Specified by:

get in interface java.util.List<T>

Specified by:

get in interface ListIterable<T>

contains

public boolean contains(java.lang.Object obj)

Description copied from interface: RichIterable

Returns true if the iterable has an element which responds true to element.equals(object).

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.List<T>

Specified by:

contains in interface RichIterable<T>

Overrides:

contains in class AbstractRichIterable<T>

newWith

public ImmutableList<T> newWith(T newItem)

Description copied from interface: ImmutableCollection

This method is similar to the with method in MutableCollection with the difference that a new copy of this collection with the element appended will be returned.

Specified by:

newWith in interface ImmutableCollection<T>

Specified by:

newWith in interface ImmutableList<T>