ImmutableList (KeY API Documentation)

All Superinterfaces:

java.lang.Iterable<T>, java.io.Serializable

All Known Implementing Classes:

ImmutableSLList, ImmutableSLList.Cons, ImmutableSLList.NIL
```
public interface ImmutableList<T>
extends java.lang.Iterable<T>, java.io.Serializable
```
List interface to be implemented by non-destructive lists

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ImmutableList<T>`	`append(ImmutableList<T> list)` appends a whole list (non-destructive)
`ImmutableList<T>`	`append(java.lang.Iterable<T> collection)` appends an iterable collection
`ImmutableList<T>`	`append(T... array)` appends element at end (non-destructive) (O(n))
`ImmutableList<T>`	`append(T element)` appends element to the list (non-destructive)
`boolean`	`contains(T obj)`
`boolean`	`exists(java.util.function.Predicate<T> predicate)` return true if predicate is fullfilled for at least one element
`T`	`head()`
`boolean`	`isEmpty()`
`java.util.Iterator<T>`	`iterator()`
`ImmutableList<T>`	`prepend(ImmutableList<T> list)` prepends a whole list (non-destructive)
`ImmutableList<T>`	`prepend(T... array)` prepends array (O(n))
`ImmutableList<T>`	`prepend(T element)` prepends element to the list (non-destructive)
`ImmutableList<T>`	`prependReverse(ImmutableList<T> collection)` prepends an immutable list in reverse order, i.e., [4,5,6].prepend([1,2,3]) will be [3,2,1,4,5,6] (more efficient than `prepend(ImmutableList)`)
`ImmutableList<T>`	`prependReverse(java.lang.Iterable<T> collection)` prepends an iterable collection in reverse order, i.e., [4,5,6].prepend([1,2,3]) will be [3,2,1,4,5,6]
`ImmutableList<T>`	`removeAll(T obj)` removes all occurrences of obj
`ImmutableList<T>`	`removeFirst(T obj)` removes first occurrence of obj
`ImmutableList<T>`	`reverse()` Reverses this list
`int`	`size()`
`default java.util.stream.Stream<T>`	`stream()` A stream object for this collection.
`ImmutableList<T>`	`tail()`
`ImmutableList<T>`	`take(int n)`
`<S> S[]`	`toArray(java.lang.Class<S> type)` Convert the list to a Java array (O(n))
`<S> S[]`	`toArray(S[] array)` Convert the list to a Java array (O(n))

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - prepend
```
ImmutableList<T> prepend(T element)
```
    prepends element to the list (non-destructive)
    
    Parameters:
    
    element - the head of the created list
    
    Returns:
    
    IList with the new element as head and this list as tail
  - prepend
```
ImmutableList<T> prepend(ImmutableList<T> list)
```
    prepends a whole list (non-destructive)
    
    Parameters:
    
    list - the list to be prepended
    
    Returns:
    
    IList list++this
  - prependReverse
```
ImmutableList<T> prependReverse(ImmutableList<T> collection)
```
    prepends an immutable list in reverse order, i.e., [4,5,6].prepend([1,2,3]) will be [3,2,1,4,5,6] (more efficient than prepend(ImmutableList))
    
    Returns:
    
    reverse(collection)++this
  - prependReverse
```
ImmutableList<T> prependReverse(java.lang.Iterable<T> collection)
```
    prepends an iterable collection in reverse order, i.e., [4,5,6].prepend([1,2,3]) will be [3,2,1,4,5,6]
    
    Returns:
    
    reverse(collection)++this
  - prepend
```
ImmutableList<T> prepend(T... array)
```
    prepends array (O(n))
    
    Parameters:
    
    array - the array of the elements to be prepended
    
    Returns:
    
    IList the new list
  - append
```
ImmutableList<T> append(T element)
```
    appends element to the list (non-destructive)
    
    Parameters:
    
    element - to be added at the end
    
    Returns:
    
    IList with the new element at the end
  - append
```
ImmutableList<T> append(ImmutableList<T> list)
```
    appends a whole list (non-destructive)
    
    Parameters:
    
    list - the list to be appended
    
    Returns:
    
    IList this++list
  - append
```
ImmutableList<T> append(java.lang.Iterable<T> collection)
```
    appends an iterable collection
  - append
```
ImmutableList<T> append(T... array)
```
    appends element at end (non-destructive) (O(n))
    
    Parameters:
    
    array - the array to be appended
    
    Returns:
    
    IList the new list
  - head
```
T head()
```
    Returns:
    
    the first element in list
  - exists
```
boolean exists(java.util.function.Predicate<T> predicate)
```
    return true if predicate is fullfilled for at least one element
    
    Parameters:
    
    predicate - the predicate
    
    Returns:
    
    true if predicate is fullfilled for at least one element
  - tail
```
ImmutableList<T> tail()
```
    Returns:
    
    IList tail of list
  - take
```
ImmutableList<T> take(int n)
```
    Returns:
    
    IList this list without the first n elements
  - reverse
```
ImmutableList<T> reverse()
```
    Reverses this list
  - iterator
```
java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
    
    Returns:
    
    Iterator of this list
  - contains
```
boolean contains(T obj)
```
    Returns:
    
    boolean is true iff. obj is in List
  - size
```
int size()
```
    Returns:
    
    int representing number of elements in list
  - isEmpty
```
boolean isEmpty()
```
    Returns:
    
    true iff the list is empty
  - removeFirst
```
ImmutableList<T> removeFirst(T obj)
```
    removes first occurrence of obj
    
    Returns:
    
    new list
  - removeAll
```
ImmutableList<T> removeAll(T obj)
```
    removes all occurrences of obj
    
    Returns:
    
    new list
  - toArray
```
<S> S[] toArray(S[] array)
```
    Convert the list to a Java array (O(n))
  - toArray
```
<S> S[] toArray(java.lang.Class<S> type)
```
    Convert the list to a Java array (O(n))
  - stream
```
default java.util.stream.Stream<T> stream()
```
    A stream object for this collection.
    
    Returns:
    
    a non-null stream object

Interface ImmutableList<T>

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

prepend

prepend

prependReverse

prependReverse

prepend

append

append

append

append

head

exists

tail

take

reverse

iterator

contains

size

isEmpty

removeFirst

removeAll

toArray

toArray

stream