Package se.curity.identityserver.sdk

Class NonEmptyList<T>

Object

se.curity.identityserver.sdk.NonEmptyList<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>

public final class NonEmptyList<T>
extends Object
implements List<T>

A Immutable List which is guaranteed to contain at least one element.

Method Summary

Modifier and Type	Method	Description
void	add(int index, T element)	Operation not supported.
boolean	add(T t)	Operation not supported.
boolean	addAll(int index, @Nonnull Collection<? extends T> c)	Operation not supported.
boolean	addAll(@Nonnull Collection<? extends T> c)	Operation not supported.
void	clear()	Operation not supported.
boolean	contains(Object o)
boolean	containsAll(@Nonnull Collection<?> c)
boolean	equals(Object o)
void	forEach(Consumer<? super T> action)
T	get(int index)
List<T>	getAllExceptLast()
T	getFirst()
T	getLast()
List<T>	getTail()
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
@Nonnull Iterator<T>	iterator()
int	lastIndexOf(Object o)
@Nonnull ListIterator<T>	listIterator()
@Nonnull ListIterator<T>	listIterator(int index)
static <E> NonEmptyList<E>	of(E item)	Create a non-empty List containing a single item.
static <E> NonEmptyList<E>	of(E[] items)	Create a non-empty List from the provided list.
static <E> NonEmptyList<E>	of(Iterable<E> iterable)	Create a non-empty List from the provided Iterable.
Stream<T>	parallelStream()
T	remove(int index)	Operation not supported.
boolean	remove(Object o)	Operation not supported.
boolean	removeAll(@Nonnull Collection<?> c)	Operation not supported.
boolean	removeIf(Predicate<? super T> filter)	Operation not supported.
void	replaceAll(UnaryOperator<T> operator)	Operation not supported.
boolean	retainAll(@Nonnull Collection<?> c)	Operation not supported.
T	set(int index, T element)	Operation not supported.
int	size()
void	sort(Comparator<? super T> c)	Operation not supported.
Spliterator<T>	spliterator()
Stream<T>	stream()
@Nonnull List<T>	subList(int fromIndex, int toIndex)
@Nonnull Object[]	toArray()
<T1> @Nonnull T1[]	toArray(@Nonnull T1[] a)
String	toString()
NonEmptyList<T>	with(T item)	Create a new NonEmptyList containing all items of this list plus the given item.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

toArray

Method Details

getFirst

public T getFirst()

Returns:

the first element of the list. Because this list is non-empty, this method never throws an Exception.

getLast

public T getLast()

Returns:

the last element of the list. Because this list is non-empty, this method never throws an Exception.

getTail

public List<T> getTail()

Returns:

the tail of this list, ie. all elements except the first one. This is very useful for cases when the list must be broken up into its head + tail elements ([head | [tail]]).

getAllExceptLast

public List<T> getAllExceptLast()

Returns:

all the elements of this List, except for the last one. This is very useful for cases when the list must be broken up into its initial part + the last element. ([[initial] | last]).

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface List<T>

iterator

@Nonnull
public @Nonnull Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface List<T>

toArray

@Nonnull
public @Nonnull Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

toArray

@Nonnull
public <T1> @Nonnull T1[] toArray(@Nonnull T1[] a)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

add

public boolean add(T t)

Operation not supported. This is a Immutable List.

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

Parameters:

t - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

remove

public boolean remove(Object o)

Operation not supported. This is a Immutable List.

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

Parameters:

o - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

containsAll

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

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

addAll

public boolean addAll(@Nonnull Collection<? extends T> c)

Operation not supported. This is a Immutable List.

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

Parameters:

c - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

addAll

public boolean addAll(int index,
 @Nonnull Collection<? extends T> c)

Operation not supported. This is a Immutable List.

Specified by:

addAll in interface List<T>

Parameters:

index - not used

c - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

removeAll

public boolean removeAll(@Nonnull Collection<?> c)

Operation not supported. This is a Immutable List.

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

Parameters:

c - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

retainAll

public boolean retainAll(@Nonnull Collection<?> c)

Operation not supported. This is a Immutable List.

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

Parameters:

c - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

replaceAll

public void replaceAll(UnaryOperator<T> operator)

Operation not supported. This is a Immutable List.

Specified by:

replaceAll in interface List<T>

Parameters:

operator - not used

Throws:

UnsupportedOperationException - if called

sort

public void sort(Comparator<? super T> c)

Operation not supported. This is a Immutable List.

Specified by:

sort in interface List<T>

Parameters:

c - not used

Throws:

UnsupportedOperationException - if called

clear

public void clear()

Operation not supported. This is a Immutable List.

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

Throws:

UnsupportedOperationException - if called

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface List<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface List<T>

Overrides:

hashCode in class Object

get

public T get(int index)

Specified by:

get in interface List<T>

set

public T set(int index,
 T element)

Operation not supported. This is a Immutable List.

Specified by:

set in interface List<T>

Parameters:

index - not used

element - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

add

public void add(int index,
 T element)

Operation not supported. This is a Immutable List.

Specified by:

add in interface List<T>

Parameters:

index - not used

element - not used

Throws:

UnsupportedOperationException - if called

remove

public T remove(int index)

Operation not supported. This is a Immutable List.

Specified by:

remove in interface List<T>

Parameters:

index - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T>

listIterator

@Nonnull
public @Nonnull ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

listIterator

@Nonnull
public @Nonnull ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T>

subList

@Nonnull
public @Nonnull List<T> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<T>

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Collection<T>

Specified by:

spliterator in interface Iterable<T>

Specified by:

spliterator in interface List<T>

removeIf

public boolean removeIf(Predicate<? super T> filter)

Operation not supported. This is a Immutable List.

Specified by:

removeIf in interface Collection<T>

Parameters:

filter - not used

Returns:

nothing

Throws:

UnsupportedOperationException - if called

stream

public Stream<T> stream()

Specified by:

stream in interface Collection<T>

parallelStream

public Stream<T> parallelStream()

Specified by:

parallelStream in interface Collection<T>

forEach

public void forEach(Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T>

of

public static <E> NonEmptyList<E> of(Iterable<E> iterable)

Create a non-empty List from the provided Iterable.

Type Parameters:

E - type of elements

Parameters:

iterable - containing at least one element.

Returns:

a non-empty List

Throws:

IllegalArgumentException - if the list is empty

of

public static <E> NonEmptyList<E> of(E[] items)

Create a non-empty List from the provided list.

Type Parameters:

E - type of elements

Parameters:

items - containing at least one element.

Returns:

a non-empty List

Throws:

IllegalArgumentException - if the array is empty

of

public static <E> NonEmptyList<E> of(E item)

Create a non-empty List containing a single item.

Type Parameters:

E - type of element

Parameters:

item - single item of the List.

Returns:

a non-empty List

with

public NonEmptyList<T> with(T item)

Create a new NonEmptyList containing all items of this list plus the given item.

Parameters:

item - to append to the list

Returns:

the result of appending the given item to a copy of this List.

Since:

2.1

toString

public String toString()

Overrides:

toString in class Object