OCamlFunction3 (OCaml-Java)

java.lang.Object
- org.ocamljava.runtime.wrappers.OCamlValue
- - org.ocamljava.runtime.wrappers.OCamlFunction3<T0,T1,T2,TR>

public abstract class OCamlFunction3<T0 extends OCamlValue,T1 extends OCamlValue,T2 extends OCamlValue,TR extends OCamlValue>
extends OCamlValue

The OCamlFunction3 class represent an OCaml function taking three parameter.

Since:: 2.0
Version:: 2.0
Author:: Xavier Clerc

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

Constructor Summary

Constructors
Constructor and Description
`OCamlFunction3()` Constructs a new instance.
`OCamlFunction3(Wrapper<T0> w0, Wrapper<T1> w1, Wrapper<T2> w2, Wrapper<TR> wr)` Constructs a new instance.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`abstract TR`	`execute(T0 p0, T1 p1, T2 p2)` The actual implementation of the function
`org.ocamljava.runtime.values.Value`	`getClosure(Wrapper<T0> w0, Wrapper<T1> w1, Wrapper<T2> w2)` Returns the closure to be executed from the OCaml runtime.
`Wrapper<? extends OCamlFunction3<T0,T1,T2,TR>>`	`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.lang.String`	`toString()`
`static <T0 extends OCamlValue,T1 extends OCamlValue,T2 extends OCamlValue,TR extends OCamlValue> OCamlFunction3<T0,T1,T2,TR>`	`wrap(Wrapper<T0> w0, Wrapper<T1> w1, Wrapper<T2> w2, Wrapper<TR> wr, org.ocamljava.runtime.values.Value v)` Wraps the passed value.
`static <T0 extends OCamlValue,T1 extends OCamlValue,T2 extends OCamlValue,TR extends OCamlValue> Wrapper<? extends OCamlFunction3<T0,T1,T2,TR>>`	`wrapper(Wrapper<T0> w0, Wrapper<T1> w1, Wrapper<T2> w2, Wrapper<TR> wr)` Returns a wrapper for `OCamlFunction3` 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

Constructor Detail
- OCamlFunction3
```
public OCamlFunction3(Wrapper<T0> w0,
              Wrapper<T1> w1,
              Wrapper<T2> w2,
              Wrapper<TR> wr)
```
  Constructs a new instance.
  To be used by Java implementations.
  
  Parameters:
  w0 - wrapper for first parameter - should not be null
  w1 - wrapper for second parameter - should not be null
  w2 - wrapper for third parameter - should not be null
  wr - wrapper for result - should not be null
- OCamlFunction3
```
public OCamlFunction3()
```
  Constructs a new instance.
  To be used by Java implementations.

Method Detail

getWrapper
```
public final Wrapper<? extends OCamlFunction3<T0,T1,T2,TR>> 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.

getClosure

public org.ocamljava.runtime.values.Value getClosure(Wrapper<T0> w0,
                                            Wrapper<T1> w1,
                                            Wrapper<T2> w2)

Returns the closure to be executed from the OCaml runtime.

Parameters:: w0 - wrapper for first parameter - should not be null; w1 - wrapper for second parameter - should not be null; w2 - wrapper for third parameter - should not be null
Returns:: the closure to be executed on the OCaml side

execute
```
public abstract TR execute(T0 p0,
         T1 p1,
         T2 p2)
                                       throws OCamlException
```
The actual implementation of the function

Parameters:
p0 - first parameter - should not be null
p1 - second parameter - should not be null
p2 - third parameter - should not be null

Throws:

OCamlException - if function fails

hashCode
```
public final int hashCode()
```
Overrides:

hashCode in class OCamlValue

equals

public final boolean equals(java.lang.Object obj)

Overrides:: equals in class OCamlValue

toString

public final java.lang.String toString()

Overrides:: toString in class OCamlValue

wrap

public static <T0 extends OCamlValue,T1 extends OCamlValue,T2 extends OCamlValue,TR extends OCamlValue> OCamlFunction3<T0,T1,T2,TR> wrap(Wrapper<T0> w0,
                                                                                                                         Wrapper<T1> w1,
                                                                                                                         Wrapper<T2> w2,
                                                                                                                         Wrapper<TR> wr,
                                                                                                                         org.ocamljava.runtime.values.Value v)

Wraps the passed value.

Parameters:: w0 - wrapper for first parameter - should not be null; w1 - wrapper for second parameter - should not be null; w2 - wrapper for third parameter - should not be null; wr - wrapper for result - should not be null; v - value to wrap - should not be null
Returns:: a new OCamlFunction3 instance wrapping the passed value

wrapper

public static <T0 extends OCamlValue,T1 extends OCamlValue,T2 extends OCamlValue,TR extends OCamlValue> Wrapper<? extends OCamlFunction3<T0,T1,T2,TR>> wrapper(Wrapper<T0> w0,
                                                                                                                                               Wrapper<T1> w1,
                                                                                                                                               Wrapper<T2> w2,
                                                                                                                                               Wrapper<TR> wr)

Returns a wrapper for OCamlFunction3 values.

Parameters:: w0 - wrapper for first parameter - should not be null; w1 - wrapper for second parameter - should not be null; w2 - wrapper for third parameter - should not be null; wr - wrapper for result - should not be null
Returns:: a wrapper for OCamlFunction3 values

Class OCamlFunction3<T0 extends OCamlValue,T1 extends OCamlValue,T2 extends OCamlValue,TR extends OCamlValue>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

OCamlFunction3