com.scalar.dl.ledger.function

Class JsonpBasedFunction

java.lang.Object

com.scalar.dl.ledger.function.JsonpBasedFunction

public abstract class JsonpBasedFunction
extends java.lang.Object

A base function using JSONP for the invoke method arguments and invoke method return type. You can create your functions based on it. Unless you have a special reason to use this class like migrating from the old Function without changing the code much, it is recommended to use JacksonBasedFunction since it is faster.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	contractContext
protected T	contractProperties

Constructor Summary

Constructors

Constructor and Description
JsonpBasedFunction()

Method Summary

Modifier and Type	Method and Description
protected T	getContractContext() Returns a contract context given from a contract that is executed together with the function.
protected T	getContractProperties()
abstract T	invoke(Database<G,S,P,D,R> database, T functionArgument, T contractArgument, T contractProperties) Invokes the function to Database with the specified argument and the corresponding root contract argument and properties.
protected T	invoke(java.lang.String functionId, Database<G,S,P,D,R> database, T functionArgument, T contractArgument)
boolean	isRoot()

Methods inherited from class java.lang.Object

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

Field Detail

contractProperties

protected T contractProperties

contractContext

protected T contractContext

Constructor Detail

JsonpBasedFunction

public JsonpBasedFunction()

Method Detail

getContractProperties

@Nullable
protected T getContractProperties()

isRoot

public boolean isRoot()

getContractContext

@Nullable
protected T getContractContext()

Returns a contract context given from a contract that is executed together with the function.

Returns:

contract context

invoke

@Nullable
public abstract T invoke(Database<G,S,P,D,R> database,
                                   @Nullable
                                   T functionArgument,
                                   T contractArgument,
                                   @Nullable
                                   T contractProperties)

Invokes the function to Database with the specified argument and the corresponding root contract argument and properties. An implementation of the FunctionBase should throw ContractContextException if it faces application-level contextual error (such as lack of balance in payment application).

Parameters:

database - mutable database

functionArgument - function argument

contractArgument - the argument of the corresponding root contract

contractProperties - the pre-registered properties of the corresponding root contract

invoke

@Nullable
protected final T invoke(java.lang.String functionId,
                                   Database<G,S,P,D,R> database,
                                   @Nullable
                                   T functionArgument,
                                   T contractArgument)