com.phloc.commons.collections.list

Class SingleElementList<ELEMENTTYPE>

java.lang.Object

com.phloc.commons.collections.list.SingleElementList<ELEMENTTYPE>

Type Parameters:

ELEMENTTYPE - The type of the element in the list

All Implemented Interfaces:

IHasSize, Iterable<ELEMENTTYPE>, Collection<ELEMENTTYPE>, List<ELEMENTTYPE>

@NotThreadSafe
public class SingleElementList<ELEMENTTYPE>
extends Object
implements List<ELEMENTTYPE>, IHasSize

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

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
SingleElementList()
SingleElementList(ELEMENTTYPE aElement)

Method Summary

Methods

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)
static <ELEMENTTYPE> SingleElementList<ELEMENTTYPE>	create(ELEMENTTYPE aElement)
boolean	equals(Object o)
ELEMENTTYPE	get(int nIndex)
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()
List<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

Constructor Detail

SingleElementList

public SingleElementList()

SingleElementList

public SingleElementList(@Nullable
                 ELEMENTTYPE aElement)

Method Detail

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 IHasSize

Specified by:

isEmpty in interface Collection<ELEMENTTYPE>

Specified by:

isEmpty in interface List<ELEMENTTYPE>

Returns:

true if no items are present, false if at least a single item is present.

See Also:

IHasSize.size()

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 IHasSize

Specified by:

size in interface Collection<ELEMENTTYPE>

Specified by:

size in interface List<ELEMENTTYPE>

Returns:

The number of contained elements. Always ≥ 0.

subList

@Nonnull
public List<ELEMENTTYPE> subList(int nFromIndex,
                                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

create

@Nonnull
public static <ELEMENTTYPE> SingleElementList<ELEMENTTYPE> create(@Nullable
                                                          ELEMENTTYPE aElement)