Package de.iip_ecosphere.platform.support.json

Class JsonResultWrapper

java.lang.Object

de.iip_ecosphere.platform.support.json.JsonResultWrapper

All Implemented Interfaces:

Serializable, Function<Object[],Object>

public class JsonResultWrapper
extends Object
implements Function<Object[],Object>, Serializable

Uniform JSON way to represent results of operations that may fail.

Author:

Holger Eichelberger, SSE

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JsonResultWrapper.ExceptionFunction	A function that may throw an exception.
static interface	JsonResultWrapper.OperationCompletedListener	Allows to track operations.
static class	JsonResultWrapper.Result	Represents the result w/o exception.

Field Summary

Fields

Modifier and Type	Field	Description
private JsonResultWrapper.ExceptionFunction	func
private JsonResultWrapper.OperationCompletedListener	listener
private static final Json	MAPPER
private static final long	serialVersionUID
private Function<Object[],String>	taskIdSupplier

Constructor Summary

Constructors

Constructor	Description
JsonResultWrapper(JsonResultWrapper.ExceptionFunction func)	Creates a wrapper object.
JsonResultWrapper(JsonResultWrapper.ExceptionFunction func, JsonResultWrapper.OperationCompletedListener listener)	Creates a wrapper object.
JsonResultWrapper(JsonResultWrapper.ExceptionFunction func, JsonResultWrapper.OperationCompletedListener listener, Function<Object[],String> taskIdSupplier)	Creates a wrapper object.
JsonResultWrapper(JsonResultWrapper.ExceptionFunction func, Function<Object[],String> taskIdSupplier)	Creates a wrapper object.

Method Summary

Modifier and Type	Method	Description
Object	apply(Object[] param)
static String	fromJson(Object json)	Turns something in JSON into a result via an instance of Result.
static String	fromJson(Function<Object[],Object> function, Object... params)	Executes function with params and catches all occurring exceptions turning them into an ExecutionException.
static JsonResultWrapper.Result	resultFromJson(Object json)	Turns something in JSON into a Result.
static String	toJson(JsonResultWrapper.Result res)	Turns a JsonResultWrapper.Result into JSON.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

MAPPER

private static final Json MAPPER

func

private JsonResultWrapper.ExceptionFunction func

listener

private JsonResultWrapper.OperationCompletedListener listener

taskIdSupplier

private Function<Object[],String> taskIdSupplier

Constructor Details

JsonResultWrapper

public JsonResultWrapper(JsonResultWrapper.ExceptionFunction func)

Creates a wrapper object.

Parameters:

func - a function that may throw an exception.

JsonResultWrapper

public JsonResultWrapper(JsonResultWrapper.ExceptionFunction func,
 JsonResultWrapper.OperationCompletedListener listener)

Creates a wrapper object.

Parameters:

func - a function that may throw an exception.

listener - optional operation completed listener

JsonResultWrapper

public JsonResultWrapper(JsonResultWrapper.ExceptionFunction func,
 Function<Object[],String> taskIdSupplier)

Creates a wrapper object.

Parameters:

func - a function that may throw an exception.

taskIdSupplier - optional task id to track via TaskRegistry

JsonResultWrapper

public JsonResultWrapper(JsonResultWrapper.ExceptionFunction func,
 JsonResultWrapper.OperationCompletedListener listener,
 Function<Object[],String> taskIdSupplier)

Creates a wrapper object.

Parameters:

func - a function that may throw an exception.

listener - optional operation completed listener

taskIdSupplier - optional task id to track via TaskRegistry

Method Details

apply

public Object apply(Object[] param)

Specified by:

apply in interface Function<Object[],Object>

toJson

public static String toJson(JsonResultWrapper.Result res)

Turns a JsonResultWrapper.Result into JSON.

Parameters:

res - the result instance (may be null)

Returns:

the JSON string or an empty string in case of problems/no address

resultFromJson

public static JsonResultWrapper.Result resultFromJson(Object json)

Turns something in JSON into a Result.

Parameters:

json - the JSON value, usually a String

Returns:

the result instance

fromJson

public static String fromJson(Object json)
                       throws ExecutionException

Turns something in JSON into a result via an instance of Result.

Parameters:

json - the JSON value, usually a String

Returns:

the result value, may be null, e.g., if json is null

Throws:

ExecutionException - if the parsed JsonResultWrapper.Result represents an exception

fromJson

public static String fromJson(Function<Object[],Object> function,
 Object... params)
                       throws ExecutionException

Executes function with params and catches all occurring exceptions turning them into an ExecutionException.

Parameters:

function - the function to be executed, must return a JsonResultWrapper.Result as JSON, e.g., an instance of JsonResultWrapper

params - the function parameters

Returns:

the return value

Throws:

ExecutionException - in case that function cannot be executed