net.java.html.lib

Class Function

java.lang.Object

net.java.html.lib.Objs

net.java.html.lib.Function

Direct Known Subclasses:

Type

public class Function
extends Objs

Wrapper around JavaScript function.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Function.A0<R> Java function with no arguments.
static interface	Function.A1<P1,R> Java function with one argument.
static interface	Function.A2<P1,P2,R> Java function with two arguments.
static interface	Function.A3<P1,P2,P3,R> Java function with three arguments.
static interface	Function.A4<P1,P2,P3,P4,R> Java function with four arguments.
static interface	Function.A5<P1,P2,P3,P4,P5,R> Java function with five arguments.

Nested classes/interfaces inherited from class net.java.html.lib.Objs

Objs.Constructor<T extends Objs>, Objs.Property<T>

Field Summary

Fields

Modifier and Type	Field and Description
Objs.Property<Number>	length
Objs.Property<Objs>	prototype

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Function(Objs.Constructor<?> constructor, Object js)
	Function(String... args) Creates a new function.

Method Summary

Modifier and Type	Method and Description
static Function	$as(Object obj) Casts given object to this class.
static Object	$call(Object fn, Object... params) Invokes an object that represents a function - e.g.
Object	apply(Object thisArg, Object... argArray) Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
Object	bind(Object thisArg, Object... argArray) For a given function, creates a bound function that has the same body as the original function.
static <A> Function	newFunction(Function.A1<? super A,? extends Object> fn, Class<A> argTypeA) Factory method that wraps provided function interface into JavaScript function object.
static <A,B> Function	newFunction(Function.A2<? super A,? super B,? extends Object> fn, Class<A> argTypeA, Class<B> argTypeB) Factory method that wraps provided function interface into JavaScript function object.
static <A,B,C> Function	newFunction(Function.A3<? super A,? super B,? super C,? extends Object> fn, Class<A> argTypeA, Class<B> argTypeB, Class<C> argTypeC) Factory method that wraps provided function interface into JavaScript function object.
static <A,B,C,D> Function	newFunction(Function.A4<? super A,? super B,? super C,? super D,? extends Object> fn, Class<A> argTypeA, Class<B> argTypeB, Class<C> argTypeC, Class<D> argTypeD) Factory method that wraps provided function interface into JavaScript function object.
static Function	newFunction(Function.A5<? extends Object,? extends Object,? extends Object,? extends Object,? extends Object,? extends Object> fn) Factory method that wraps provided function interface into JavaScript function object.
static Function	newFunction(Function.A5<? extends Object,? extends Object,? extends Object,? extends Object,? extends Object,? extends Object> fn, Class[] argTypes) Factory method that wraps provided function interface into JavaScript function object.
static <A,B,C,D,E> Function	newFunction(Function.A5<? super A,? super B,? super C,? super D,? super E,? extends Object> fn, Class<A> argTypeA, Class<B> argTypeB, Class<C> argTypeC, Class<D> argTypeD, Class<E> argTypeE) Factory method that wraps provided function interface into JavaScript function object.
static Function	newFunction(String... args) Calls the constructor.

Methods inherited from class net.java.html.lib.Objs

$as, $cast, $delete, $get, $js, $set, create, create, defineProperties, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, newObject, newObject, preventExtensions, propertyIsEnumerable, seal, toLocaleString, toString, valueOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

prototype

public final Objs.Property<Objs> prototype

length

public final Objs.Property<Number> length

Constructor Detail

Function

protected Function(Objs.Constructor<?> constructor,
                   Object js)

Function

public Function(String... args)

Creates a new function.

Parameters:

args - a list of arguments the function accepts followed by function's body

Method Detail

$as

public static Function $as(Object obj)

Casts given object to this class.

Parameters:

obj - any object

Returns:

a view of the provided obj object

apply

public Object apply(Object thisArg,
                    Object... argArray)

Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

Parameters:

thisArg - The object to be used as the this object.

argArray - A set of arguments to be passed to the function.

bind

public Object bind(Object thisArg,
                   Object... argArray)

For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

Parameters:

thisArg - An object to which the this keyword can refer inside the new function.

argArray - A list of arguments to be passed to the new function.

newFunction

public static Function newFunction(String... args)

Calls the constructor.

Parameters:

args - a list of arguments the function accepts followed by function's body

Returns:

new instance of the function

newFunction

public static <A> Function newFunction(Function.A1<? super A,? extends Object> fn,
                                       Class<A> argTypeA)

Factory method that wraps provided function interface into JavaScript function object. One can specify argument types of individual parameters.

Type Parameters:

A - type of parameter A

Parameters:

fn - implementation of the function to wrap

argTypeA - class of parameter A

Returns:

instance wrapping the JavaScript representation of the function

newFunction

public static <A,B> Function newFunction(Function.A2<? super A,? super B,? extends Object> fn,
                                         Class<A> argTypeA,
                                         Class<B> argTypeB)

Factory method that wraps provided function interface into JavaScript function object. One can specify argument types of individual parameters.

Type Parameters:

A - type of parameter A

B - type of parameter B

Parameters:

fn - implementation of the function to wrap

argTypeA - class of parameter A

argTypeB - class of parameter B

Returns:

instance wrapping the JavaScript representation of the function

newFunction

public static <A,B,C> Function newFunction(Function.A3<? super A,? super B,? super C,? extends Object> fn,
                                           Class<A> argTypeA,
                                           Class<B> argTypeB,
                                           Class<C> argTypeC)

Factory method that wraps provided function interface into JavaScript function object. One can specify argument types of individual parameters.

Type Parameters:

A - type of parameter A

B - type of parameter B

C - type of parameter C

Parameters:

fn - implementation of the function to wrap

argTypeA - class of parameter A

argTypeB - class of parameter B

argTypeC - class of parameter C

Returns:

instance wrapping the JavaScript representation of the function

newFunction

public static <A,B,C,D> Function newFunction(Function.A4<? super A,? super B,? super C,? super D,? extends Object> fn,
                                             Class<A> argTypeA,
                                             Class<B> argTypeB,
                                             Class<C> argTypeC,
                                             Class<D> argTypeD)

Factory method that wraps provided function interface into JavaScript function object. One can specify argument types of individual parameters.

Type Parameters:

A - type of parameter A

B - type of parameter B

C - type of parameter C

D - type of parameter D

Parameters:

fn - implementation of the function to wrap

argTypeA - class of parameter A

argTypeB - class of parameter B

argTypeC - class of parameter C

argTypeD - class of parameter D

Returns:

instance wrapping the JavaScript representation of the function

newFunction

public static <A,B,C,D,E> Function newFunction(Function.A5<? super A,? super B,? super C,? super D,? super E,? extends Object> fn,
                                               Class<A> argTypeA,
                                               Class<B> argTypeB,
                                               Class<C> argTypeC,
                                               Class<D> argTypeD,
                                               Class<E> argTypeE)

Factory method that wraps provided function interface into JavaScript function object. One can specify argument types of individual parameters.

Type Parameters:

A - type of parameter A

B - type of parameter B

C - type of parameter C

D - type of parameter D

E - type of parameter E

Parameters:

fn - implementation of the function to wrap

argTypeA - class of parameter A

argTypeB - class of parameter B

argTypeC - class of parameter C

argTypeD - class of parameter D

argTypeE - class of parameter E

Returns:

instance wrapping the JavaScript representation of the function

newFunction

public static Function newFunction(Function.A5<? extends Object,? extends Object,? extends Object,? extends Object,? extends Object,? extends Object> fn)

Factory method that wraps provided function interface into JavaScript function object.

Parameters:

fn - the implementation of the function

Returns:

instance wrapping the JavaScript representation of the function

newFunction

public static Function newFunction(Function.A5<? extends Object,? extends Object,? extends Object,? extends Object,? extends Object,? extends Object> fn,
                                   Class[] argTypes)

Factory method that wraps provided function interface into JavaScript function object. One can specify argument types of individual parameters.

Parameters:

fn - the implementation of the function

argTypes - array with classes of the arguments

Returns:

instance wrapping the JavaScript representation of the function

$call

public static Object $call(Object fn,
                           Object... params)

Invokes an object that represents a function - e.g. Function.A0, Function.A1, etc.

Parameters:

fn - the object representing a function

params - parameters to pass to the function

Returns:

value returned by the function

Throws:

IllegalArgumentException - if the object fn isn't a function