OCamlArray (OCaml-Java)

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

All Implemented Interfaces:

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

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> OCamlArray<T>`	`create(int sz, T v)` Constructs a new `'a array` value, and wraps it.
`static <T extends OCamlValue> OCamlArray<T>`	`create(Wrapper<T> w, T[] v)` Constructs a new `'a array` value, and wraps it.
`boolean`	`equals(java.lang.Object obj)`
`T`	`get(int idx)` Returns the value at the specified index.
`Wrapper<? extends OCamlArray<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()`
`java.util.Iterator<T>`	`iterator()`
`long`	`length()` Returns the array length.
`void`	`set(int idx, T v)` Changes the value at the specified index.
`java.lang.String`	`toString()`
`static <T extends OCamlValue> OCamlArray<T>`	`wrap(Wrapper<T> w, org.ocamljava.runtime.values.Value v)` Wraps the passed value.
`static <T extends OCamlValue> Wrapper<? extends OCamlArray<T>>`	`wrapper(Wrapper<T> w)` Returns a wrapper for `OCamlArray` 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 OCamlArray<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.
  - get
```
public T get(int idx)
```
    Returns the value at the specified index.
    
    Parameters:
    idx - index of value
    
    Returns:
    the value at the specified index
  - set
```
public void set(int idx,
       T v)
```
    Changes the value at the specified index.
    
    Parameters:
    idx - index of value to modify
    v - new value
  - length
```
public long length()
```
    Returns the array length.
    
    Returns:
    the array length
  - 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> OCamlArray<T> create(int sz,
                                          T v)
```
    Constructs a new 'a array value, and wraps it.
    
    Parameters:
    sz - array size - should not be negative
    v - initial value for each array element - should not be null
    
    Returns:
    a new OCamlArray instance wrapping the passed value
  - create
```
public static <T extends OCamlValue> OCamlArray<T> create(Wrapper<T> w,
                                          T[] v)
```
    Constructs a new 'a array value, and wraps it.
    The passed array is copied and hence its modification are not reflected by the wrapped value.
    
    Parameters:
    w - wrapper for elements - should not be null
    v - array to wrap - should not be null
    
    Returns:
    a new OCamlArray instance wrapping the passed value
  - wrap
```
public static <T extends OCamlValue> OCamlArray<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 OCamlArray instance wrapping the passed value
  - wrapper
```
public static <T extends OCamlValue> Wrapper<? extends OCamlArray<T>> wrapper(Wrapper<T> w)
```
    Returns a wrapper for OCamlArray values.
    
    Parameters:
    w - wrapper for elements - should not be null
    
    Returns:
    a wrapper for OCamlArray values

Class OCamlArray<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

get

set

length

iterator

hashCode

equals

toString

create

create

wrap

wrapper