OCamlList (OCaml-Java)

java.lang.Object
- org.ocamljava.runtime.wrappers.OCamlValue
- - org.ocamljava.runtime.wrappers.OCamlList<T>

All Implemented Interfaces:

java.lang.Iterable<T>
```
public final class OCamlList<T extends OCamlValue>
extends OCamlValue
implements java.lang.Iterable<T>
```
The OCamlList class is the wrapper class for OCaml values of type 'a list.

Since:

2.0

Version:

2.0

Author:

Xavier Clerc

Field Summary
- Fields inherited from class org.ocamljava.runtime.wrappers.OCamlValue
  WRAPPER

Method Summary

Methods
Modifier and Type	Method and Description
`static <T extends OCamlValue> OCamlList<T>`	`create(java.util.List<T> v)`
`static <T extends OCamlValue> OCamlList<T>`	`create(T hd, OCamlList<T> tl)` Constructs a new `'a list` value.
`static <T extends OCamlValue> OCamlList<T>`	`create(Wrapper<T> w)` Constructs a new `'a list` value.
`static <T extends OCamlValue> OCamlList<T>`	`create(Wrapper<T> w, java.util.List<T> v)` Constructs a new `'a list` value, and wraps it.
`boolean`	`equals(java.lang.Object obj)`
`Wrapper<? extends OCamlList<T>>`	`getWrapper()` Returns the wrapper used to wrap `Value` elements into instances of the current class.
`Wrapper<? extends OCamlValue>`	`getWrapper(int idx)` Returns the wrapper used to wrap `Value` elements into instances of the embedded type at given index.
`int`	`hashCode()`
`T`	`head()` Returns the head of the list.
`boolean`	`isEmpty()` Tests whether the list is empty.
`java.util.Iterator<T>`	`iterator()`
`long`	`length()` Returns the list length.
`OCamlList<T>`	`tail()` Returns the tail of the list.
`java.lang.String`	`toString()`
`static <T extends OCamlValue> OCamlList<T>`	`wrap(Wrapper<T> w, org.ocamljava.runtime.values.Value v)` Wraps the passed value.
`static <T extends OCamlValue> Wrapper<? extends OCamlList<T>>`	`wrapper(Wrapper<T> w)` Returns a wrapper for `OCamlList` values.

Methods inherited from class org.ocamljava.runtime.wrappers.OCamlValue
value, wrap, wrapper

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

- Method Detail
  - getWrapper
```
public Wrapper<? extends OCamlList<T>> getWrapper()
```
    Returns the wrapper used to wrap Value elements into instances of the current class.
    
    Overrides:
    
    getWrapper in class OCamlValue
    
    Returns:
    the wrapper used to wrap Value elements into instances of the current class
  - getWrapper
```
public Wrapper<? extends OCamlValue> getWrapper(int idx)
```
    Returns the wrapper used to wrap Value elements into instances of the embedded type at given index.
    
    Overrides:
    
    getWrapper in class OCamlValue
    
    Parameters:
    idx - index of embedded type
    
    Returns:
    the wrapper used to wrap Value elements into instances of the embedded type at given index.
  - isEmpty
```
public boolean isEmpty()
```
    Tests whether the list is empty.
    
    Returns:
    true if the list is empty, false otherwise
  - length
```
public long length()
```
    Returns the list length.
    
    Returns:
    the list length
  - head
```
public T head()
```
    Returns the head of the list.
    
    Returns:
    the head of the list, of null if the list is empty
  - tail
```
public OCamlList<T> tail()
```
    Returns the tail of the list.
    
    Returns:
    the tail of the list, of null if the list is empty
  - iterator
```
public java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T extends OCamlValue>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class OCamlValue
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class OCamlValue
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class OCamlValue
  - create
```
public static <T extends OCamlValue> OCamlList<T> create(Wrapper<T> w,
                                         java.util.List<T> v)
```
    Constructs a new 'a list value, and wraps it.
    The passed list is copied and hence its modification are not reflected by the wrapped value.
    
    Parameters:
    w - wrapper for elements - should not be null
    v - list to wrap - should not be null
    
    Returns:
    a new OCamlList instance wrapping the passed value
  - create
```
public static <T extends OCamlValue> OCamlList<T> create(java.util.List<T> v)
```
  - create
```
public static <T extends OCamlValue> OCamlList<T> create(Wrapper<T> w)
```
    Constructs a new 'a list value.
    
    Parameters:
    w - wrapper for elements - should not be null
    
    Returns:
    a new OCamlList instance wrapping the empty list
  - create
```
public static <T extends OCamlValue> OCamlList<T> create(T hd,
                                         OCamlList<T> tl)
```
    Constructs a new 'a list value.
    
    Parameters:
    hd - list head - should not be null
    tl - list tail - should not be null
    
    Returns:
    a new OCamlList instance wrapping the empty list
  - wrap
```
public static <T extends OCamlValue> OCamlList<T> wrap(Wrapper<T> w,
                                       org.ocamljava.runtime.values.Value v)
```
    Wraps the passed value.
    
    Parameters:
    w - wrapper for elements - should not be null
    v - value to wrap - should not be null
    
    Returns:
    a new OCamlList instance wrapping the passed value
  - wrapper
```
public static <T extends OCamlValue> Wrapper<? extends OCamlList<T>> wrapper(Wrapper<T> w)
```
    Returns a wrapper for OCamlList values.
    
    Parameters:
    w - wrapper for elements - should not be null
    
    Returns:
    a wrapper for OCamlList values

Class OCamlList<T extends OCamlValue>

Field Summary

Fields inherited from class org.ocamljava.runtime.wrappers.OCamlValue

Method Summary

Methods inherited from class org.ocamljava.runtime.wrappers.OCamlValue

Methods inherited from class java.lang.Object

Method Detail

getWrapper

getWrapper

isEmpty

length

head

tail

iterator

hashCode

equals

toString

create

create

create

create

wrap

wrapper