PList

java.lang.Object
- org.stekikun.dolmen.common.PList<A>

Type Parameters:

A - the type of elements stored in the list

All Implemented Interfaces:

Iterable<A>
```
public final class PList<A>
extends Object
implements Iterable<A>
```
This class implements polymorphic persistent lists. Instances of persistent lists are built mainly by adding an element in front of an existing list with cons(Object, PList), starting from the empty list empty(). They are immutable and allow (thread-)safe physical sharing of suffixes.
This implementation allows null elements, in other words the type of elements A can be Nullable.

Author:

Stéphane Lescuyer

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <A> PList<A>`	`concat(PList<A> l1, PList<A> l2)` This works in constant stack size.
`static <A> PList<A>`	`cons(A head, PList<A> tail)`
`static <A> PList<A>`	`empty()`
`boolean`	`equals(@Nullable Object o)`
`void`	`forEach(@Nullable Consumer<? super A> consumer)`
`int`	`hashCode()`
`A`	`hd()`
`boolean`	`isEmpty()`
`Iterator<A>`	`iterator()`
`int`	`length()`
`static void`	`main(String[] args)` Simple tests for `PList`
`static <A> PList<A>`	`rev(PList<A> l)` This works in constant stack size.
`static <A> PList<A>`	`revAppend(PList<A> l1, PList<A> l2)` This works in constant stack size.
`static <A> PList<A>`	`singleton(A elt)`
`PList<A>`	`tl()`
`String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
spliterator

- Method Detail
  - empty
```
public static <A> PList<A> empty()
```
    Returns:
    
    the empty list
  - cons
```
public static <A> PList<A> cons(A head,
                                PList<A> tail)
```
    Parameters:
    
    head -
    
    tail -
    
    Returns:
    
    the list obtained by adding head in front of tail
  - singleton
```
public static <A> PList<A> singleton(A elt)
```
    Parameters:
    
    elt -
    
    Returns:
    
    the singleton list consisting of elt alone
  - hd
```
public A hd()
```
    Returns:
    
    the head of this list
    
    Throws:
    
    NoSuchElementException - if the list is empty
  - tl
```
public PList<A> tl()
```
    Returns:
    
    the tail of this list
    
    Throws:
    
    NoSuchElementException - if the list is empty
  - length
```
public int length()
```
    Returns:
    
    the length of this list, i.e. the number of elements in the list
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true if this list is empty
  - revAppend
```
public static <A> PList<A> revAppend(PList<A> l1,
                                     PList<A> l2)
```
    This works in constant stack size.
    
    Parameters:
    
    l1 -
    
    l2 -
    
    Returns:
    
    the list obtained by adding all the elements of l1, in reverse order, in front of the elements of l2
  - rev
```
public static <A> PList<A> rev(PList<A> l)
```
    This works in constant stack size.
    
    Parameters:
    
    l -
    
    Returns:
    
    the list obtained by reversing the elements of l
  - concat
```
public static <A> PList<A> concat(PList<A> l1,
                                  PList<A> l2)
```
    This works in constant stack size.
    
    Parameters:
    
    l1 -
    
    l2 -
    
    Returns:
    
    the list obtained by adding all the elements of l1, in order, in front of the elements of l2
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(@Nullable Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - iterator
```
public Iterator<A> iterator()
```
    Specified by:
    
    iterator in interface Iterable<A>
  - forEach
```
public void forEach(@Nullable Consumer<? super A> consumer)
```
    Specified by:
    
    forEach in interface Iterable<A>
  - main
```
public static final void main(String[] args)
```
    Simple tests for PList
    
    Parameters:
    
    args -

Class PList<A>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

empty

cons

singleton

hd

tl

length

isEmpty

revAppend

rev

concat

hashCode

equals

toString

iterator

forEach

main