ImmutableList (Weld Servlet (Uber Jar) 3.0.0.Alpha5 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - org.jboss.weld.util.collections.ImmutableList<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>
```
public abstract class ImmutableList<E>
extends java.util.AbstractList<E>
```
Weld's immutable List implementations. Based on the size of the data, methods of this class may return List instances using various storage strategies in order to achieve the best performance / memory consumption balance.

Author:

Jozef Hartinger

See Also:

WELD-1753

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImmutableList.Builder<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ImmutableList.Builder<T>`

Field Summary
- Fields inherited from class java.util.AbstractList
  modCount

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)`
`void`	`add(int index, E element)`
`boolean`	`addAll(int index, java.util.Collection<? extends E> c)`
`static <T> ImmutableList.Builder<T>`	`builder()` Creates a new empty builder for building immutable lists.
`void`	`clear()`
`static <T> org.jboss.weld.util.collections.ImmutableList.ImmutableListCollector<T>`	`collector()` Returns a collector that can be used to collect items of a stream into an immutable list.
`static <T> java.util.List<T>`	`copyOf(java.util.Collection<T> source)` Creates an immutable list that consists of the elements in the given collection.
`static <T> java.util.List<T>`	`copyOf(java.lang.Iterable<T> source)`
`static <T> java.util.List<T>`	`copyOf(T[] elements)` Creates an immutable list that consists of the elements in the given array.
`boolean`	`isEmpty()`
`java.util.Iterator<E>`	`iterator()`
`java.util.ListIterator<E>`	`listIterator()`
`static <T> java.util.List<T>`	`of(T... elements)` Creates an immutable list that consists of the given elements.
`E`	`remove(int index)`
`boolean`	`removeIf(java.util.function.Predicate<? super E> filter)`
`protected void`	`removeRange(int fromIndex, int toIndex)`
`void`	`replaceAll(java.util.function.UnaryOperator<E> operator)`
`E`	`set(int index, E element)`
`void`	`sort(java.util.Comparator<? super E> c)`
`java.util.Spliterator<E>`	`spliterator()`

Methods inherited from class java.util.AbstractList
equals, get, hashCode, indexOf, lastIndexOf, listIterator, subList

Methods inherited from class java.util.AbstractCollection
addAll, contains, containsAll, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List
addAll, contains, containsAll, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - of
```
@SafeVarargs
public static <T> java.util.List<T> of(T... elements)
```
    Creates an immutable list that consists of the given elements. This method should only be used in the varargs form. If there is a need to create an immutable list of an array of elements, copyOf(Object[]) should be used instead.
    
    Parameters:
    
    elements - the given elements
    
    Returns:
    
    an immutable list
  - copyOf
```
public static <T> java.util.List<T> copyOf(T[] elements)
```
    Creates an immutable list that consists of the elements in the given array. A copy of the given array is used which means that any modifications to the given array will not affect the immutable list.
    
    Parameters:
    
    elements - the given array of elements
    
    Returns:
    
    an immutable list
  - copyOf
```
public static <T> java.util.List<T> copyOf(java.util.Collection<T> source)
```
    Creates an immutable list that consists of the elements in the given collection. If the given collection is already an immutable list, it is returned directly.
    
    Parameters:
    
    source - the given collection
    
    Returns:
    
    an immutable list
  - copyOf
```
public static <T> java.util.List<T> copyOf(java.lang.Iterable<T> source)
```
  - collector
```
public static <T> org.jboss.weld.util.collections.ImmutableList.ImmutableListCollector<T> collector()
```
    Returns a collector that can be used to collect items of a stream into an immutable list.
    
    Returns:
    
    collector
  - builder
```
public static <T> ImmutableList.Builder<T> builder()
```
    Creates a new empty builder for building immutable lists.
    
    Returns:
    
    a new empty builder
  - add
```
public boolean add(E e)
```
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Specified by:
    
    add in interface java.util.List<E>
    
    Overrides:
    
    add in class java.util.AbstractList<E>
  - set
```
public E set(int index,
             E element)
```
    Specified by:
    
    set in interface java.util.List<E>
    
    Overrides:
    
    set in class java.util.AbstractList<E>
  - add
```
public void add(int index,
                E element)
```
    Specified by:
    
    add in interface java.util.List<E>
    
    Overrides:
    
    add in class java.util.AbstractList<E>
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface java.util.List<E>
    
    Overrides:
    
    remove in class java.util.AbstractList<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<E>
    
    Specified by:
    
    clear in interface java.util.List<E>
    
    Overrides:
    
    clear in class java.util.AbstractList<E>
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface java.util.List<E>
    
    Overrides:
    
    addAll in class java.util.AbstractList<E>
  - removeRange
```
protected void removeRange(int fromIndex,
                           int toIndex)
```
    Overrides:
    
    removeRange in class java.util.AbstractList<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection<E>
    
    Specified by:
    
    isEmpty in interface java.util.List<E>
    
    Overrides:
    
    isEmpty in class java.util.AbstractCollection<E>
  - replaceAll
```
public void replaceAll(java.util.function.UnaryOperator<E> operator)
```
  - sort
```
public void sort(java.util.Comparator<? super E> c)
```
  - removeIf
```
public boolean removeIf(java.util.function.Predicate<? super E> filter)
```
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.util.List<E>
    
    Overrides:
    
    iterator in class java.util.AbstractList<E>
  - listIterator
```
public java.util.ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface java.util.List<E>
    
    Overrides:
    
    listIterator in class java.util.AbstractList<E>
  - spliterator
```
public java.util.Spliterator<E> spliterator()
```

Class ImmutableList<E>

Nested Class Summary

Field Summary

Fields inherited from class java.util.AbstractList

Method Summary

Methods inherited from class java.util.AbstractList

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

of

copyOf

copyOf

copyOf

collector

builder

add

set

add

remove

clear

addAll

removeRange

isEmpty

replaceAll

sort

removeIf

iterator

listIterator

spliterator