com.helger.collection.single

Class SingleElementList<ELEMENTTYPE>

java.lang.Object

com.helger.collection.single.SingleElementList<ELEMENTTYPE>

Type Parameters:

ELEMENTTYPE - The type of the element in the list

All Implemented Interfaces:

com.helger.commons.collection.impl.ICommonsCollection<ELEMENTTYPE>, com.helger.commons.collection.impl.ICommonsIterable<ELEMENTTYPE>, com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE>, com.helger.commons.lang.ICloneable<com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE>>, com.helger.commons.lang.IHasSize, Serializable, Iterable<ELEMENTTYPE>, Collection<ELEMENTTYPE>, List<ELEMENTTYPE>

@NotThreadSafe
public class SingleElementList<ELEMENTTYPE>
extends Object
implements com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE>

Implementation of the ICommonsList interface handling exactly one element and no more!

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SingleElementList()
SingleElementList(ELEMENTTYPE aElement)

Method Summary

Modifier and Type	Method and Description
boolean	add(ELEMENTTYPE aElement)
void	add(int nIndex, ELEMENTTYPE aElement)
boolean	addAll(Collection<? extends ELEMENTTYPE> aElements)
boolean	addAll(int nIndex, Collection<? extends ELEMENTTYPE> aElements)
void	clear()
boolean	contains(Object aElement)
boolean	containsAll(Collection<?> aElements)
<T> SingleElementList<T>	createInstance()
boolean	equals(Object o)
ELEMENTTYPE	get(int nIndex)
SingleElementList<ELEMENTTYPE>	getClone()
int	hashCode()
int	indexOf(Object aElement)
boolean	isEmpty()
Iterator<ELEMENTTYPE>	iterator()
int	lastIndexOf(Object aElement)
ListIterator<ELEMENTTYPE>	listIterator()
ListIterator<ELEMENTTYPE>	listIterator(int nIndex)
ELEMENTTYPE	remove(int nIndex)
boolean	remove(Object aElement)
boolean	removeAll(Collection<?> aElements)
boolean	retainAll(Collection<?> aElements)
ELEMENTTYPE	set(int nIndex, ELEMENTTYPE aNewElement)
int	size()
com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE>	subList(int nFromIndex, int nToIndex)
Object[]	toArray()
<ARRAYELEMENTTYPE> ARRAYELEMENTTYPE[]	toArray(ARRAYELEMENTTYPE[] aDest)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collection.impl.ICommonsList

getAll, getAllInstanceOf, getAllMapped, getAllMapped, getAsUnmodifiable, getAtIndex, getFirst, getFirst, getLast, getLast, getSortedInline, removeAndReturnElementAtIndex, removeAtIndex, removeFirst, removeLast, reverse, setFirst, setLast, swapItems

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface com.helger.commons.collection.impl.ICommonsCollection

addAll, addAll, addAll, addAll, addAll, addAll, addAll, addAll, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addIf, addIfNotNull, addObject, getAtIndex, getAtIndex, getAtIndex, getAtIndexMapped, getAtIndexMapped, getAtIndexMapped, getAtIndexMapped, getCopyAsList, getCount, getSorted, iterator2, removeAll, removeObject, set, setAll, setAll, setAllMapped, setAllMapped

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface com.helger.commons.collection.impl.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstIndex, findFirstMapped, findFirstMapped, findLastIndex, forEach, forEachBreakable, forEachByIndex, getCount

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface com.helger.commons.lang.IHasSize

isNotEmpty

Constructor Detail

SingleElementList

public SingleElementList()

SingleElementList

public SingleElementList(@Nullable
                         ELEMENTTYPE aElement)

Method Detail

createInstance

@Nonnull
 @ReturnsMutableCopy
public <T> SingleElementList<T> createInstance()

Specified by:

createInstance in interface com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE>

getClone

@Nonnull
 @ReturnsMutableCopy
public SingleElementList<ELEMENTTYPE> getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE>>

add

public boolean add(@Nullable
                   ELEMENTTYPE aElement)

Specified by:

add in interface Collection<ELEMENTTYPE>

Specified by:

add in interface List<ELEMENTTYPE>

add

public void add(@Nonnegative
                int nIndex,
                @Nullable
                ELEMENTTYPE aElement)

Specified by:

add in interface List<ELEMENTTYPE>

addAll

public boolean addAll(@Nonnull
                      Collection<? extends ELEMENTTYPE> aElements)

Specified by:

addAll in interface Collection<ELEMENTTYPE>

Specified by:

addAll in interface List<ELEMENTTYPE>

addAll

public boolean addAll(@Nonnegative
                      int nIndex,
                      @Nonnull
                      Collection<? extends ELEMENTTYPE> aElements)

Specified by:

addAll in interface List<ELEMENTTYPE>

clear

public void clear()

Specified by:

clear in interface Collection<ELEMENTTYPE>

Specified by:

clear in interface List<ELEMENTTYPE>

contains

public boolean contains(@Nullable
                        Object aElement)

Specified by:

contains in interface Collection<ELEMENTTYPE>

Specified by:

contains in interface List<ELEMENTTYPE>

containsAll

public boolean containsAll(@Nonnull
                           Collection<?> aElements)

Specified by:

containsAll in interface Collection<ELEMENTTYPE>

Specified by:

containsAll in interface List<ELEMENTTYPE>

get

public ELEMENTTYPE get(@Nonnegative
                       int nIndex)

Specified by:

get in interface List<ELEMENTTYPE>

indexOf

public int indexOf(Object aElement)

Specified by:

indexOf in interface List<ELEMENTTYPE>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface com.helger.commons.lang.IHasSize

Specified by:

isEmpty in interface Collection<ELEMENTTYPE>

Specified by:

isEmpty in interface List<ELEMENTTYPE>

iterator

@Nonnull
public Iterator<ELEMENTTYPE> iterator()

Specified by:

iterator in interface Iterable<ELEMENTTYPE>

Specified by:

iterator in interface Collection<ELEMENTTYPE>

Specified by:

iterator in interface List<ELEMENTTYPE>

lastIndexOf

public int lastIndexOf(@Nullable
                       Object aElement)

Specified by:

lastIndexOf in interface List<ELEMENTTYPE>

listIterator

@Nonnull
public ListIterator<ELEMENTTYPE> listIterator()

Specified by:

listIterator in interface List<ELEMENTTYPE>

listIterator

@Nonnull
public ListIterator<ELEMENTTYPE> listIterator(int nIndex)

Specified by:

listIterator in interface List<ELEMENTTYPE>

remove

@Nullable
public ELEMENTTYPE remove(int nIndex)

Specified by:

remove in interface List<ELEMENTTYPE>

remove

public boolean remove(@Nullable
                      Object aElement)

Specified by:

remove in interface Collection<ELEMENTTYPE>

Specified by:

remove in interface List<ELEMENTTYPE>

removeAll

public boolean removeAll(@Nullable
                         Collection<?> aElements)

Specified by:

removeAll in interface Collection<ELEMENTTYPE>

Specified by:

removeAll in interface List<ELEMENTTYPE>

retainAll

@UnsupportedOperation
public boolean retainAll(@Nonnull
                                                Collection<?> aElements)

Specified by:

retainAll in interface Collection<ELEMENTTYPE>

Specified by:

retainAll in interface List<ELEMENTTYPE>

set

@Nullable
public ELEMENTTYPE set(@Nonnegative
                                  int nIndex,
                                  @Nullable
                                  ELEMENTTYPE aNewElement)

Specified by:

set in interface List<ELEMENTTYPE>

size

@Nonnegative
public int size()

Specified by:

size in interface com.helger.commons.lang.IHasSize

Specified by:

size in interface Collection<ELEMENTTYPE>

Specified by:

size in interface List<ELEMENTTYPE>

subList

@Nonnull
 @CodingStyleguideUnaware
public com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE> subList(@Nonnegative
                                                                                                                 int nFromIndex,
                                                                                                                 @Nonnegative
                                                                                                                 int nToIndex)

Specified by:

subList in interface List<ELEMENTTYPE>

toArray

@Nonnull
public Object[] toArray()

Specified by:

toArray in interface Collection<ELEMENTTYPE>

Specified by:

toArray in interface List<ELEMENTTYPE>

toArray

@Nonnull
public <ARRAYELEMENTTYPE> ARRAYELEMENTTYPE[] toArray(@Nonnull
                                                               ARRAYELEMENTTYPE[] aDest)

Specified by:

toArray in interface Collection<ELEMENTTYPE>

Specified by:

toArray in interface List<ELEMENTTYPE>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<ELEMENTTYPE>

Specified by:

equals in interface List<ELEMENTTYPE>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<ELEMENTTYPE>

Specified by:

hashCode in interface List<ELEMENTTYPE>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object