Package com.axelor.workflow.expression

Class WorkflowValues

java.lang.Object

com.axelor.workflow.expression.WorkflowValues

public final class WorkflowValues
extends Object

The engine's one value codec: guest values from a script (fromValue(org.graalvm.polyglot.Value)), and host values to and from JSON (encode(java.lang.Object, java.lang.String, com.axelor.workflow.expression.WorkflowValues.HostPolicy) / decode(java.lang.Object, com.axelor.workflow.expression.WorkflowValues.TagPolicy)). Run variables, captured snapshots and message payloads share it, so a date, decimal or long reads back as what it was.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowValues.HostPolicy	What to do with a host object encode(java.lang.Object, java.lang.String, com.axelor.workflow.expression.WorkflowValues.HostPolicy) cannot turn into JSON: a message refuses one, a variable stores a reference.
static interface	WorkflowValues.TagPolicy	What a caller makes of a tag this codec does not recognise.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	The key a tagged value carries its type under; @ cannot begin a JSON field name.
static final Object	UNHANDLED	Returned by a WorkflowValues.TagPolicy for a tag that is not its own; distinct from null, which a deleted record's reference reads back as.
static final String	VALUE	The key a tagged value carries its payload under.

Method Summary

Modifier and Type	Method	Description
static String	blankToNull(String value)	A blank attribute is an absent one: the schema writes "" where the author wrote nothing.
static Object	decode(Object stored, WorkflowValues.TagPolicy onTag)	The inverse of encode(java.lang.Object, java.lang.String, com.axelor.workflow.expression.WorkflowValues.HostPolicy).
static Object	encode(Object value, String path, WorkflowValues.HostPolicy onHost)	The value as something Jackson can be trusted with, or what onHost makes of the parts that are not, such as a live entity.
static Object	fromValue(org.graalvm.polyglot.Value v)	Deep-converts a GraalVM guest Value to plain Java objects that outlive the script's context.
static boolean	isTagged(Object value, String type)	Whether value is a tag of type, which a host policy's own reader asks.
static Map<String,Object>	tagged(String type, Object value)	A tagged value, as the two keys decode(java.lang.Object, com.axelor.workflow.expression.WorkflowValues.TagPolicy) reads it back by.

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

The key a tagged value carries its type under; @ cannot begin a JSON field name.

See Also:

• Constant Field Values

VALUE

public static final String VALUE

The key a tagged value carries its payload under.

See Also:

• Constant Field Values

UNHANDLED

public static final Object UNHANDLED

Returned by a WorkflowValues.TagPolicy for a tag that is not its own; distinct from null, which a deleted record's reference reads back as.

Method Details

blankToNull

public static String blankToNull(String value)

A blank attribute is an absent one: the schema writes "" where the author wrote nothing.

fromValue

public static Object fromValue(org.graalvm.polyglot.Value v)

Deep-converts a GraalVM guest Value to plain Java objects that outlive the script's context. Host objects pass through; arrays become ArrayList, objects LinkedHashMap, numbers Long when they fit and Double otherwise.

encode

public static Object encode(Object value,
 String path,
 WorkflowValues.HostPolicy onHost)

The value as something Jackson can be trusted with, or what onHost makes of the parts that are not, such as a live entity.

Values JSON cannot represent faithfully are tagged as {"@type": ..., "value": ...} so decode(java.lang.Object, com.axelor.workflow.expression.WorkflowValues.TagPolicy) restores them: temporals, decimals, longs, durations and zones. Strings, booleans, ints and nulls go plain. Enums go as their name, not tagged.

path locates the current part, so a refusal can name it.

tagged

public static Map<String,Object> tagged(String type,
 Object value)

A tagged value, as the two keys decode(java.lang.Object, com.axelor.workflow.expression.WorkflowValues.TagPolicy) reads it back by.

isTagged

public static boolean isTagged(Object value,
 String type)

Whether value is a tag of type, which a host policy's own reader asks.

decode

public static Object decode(Object stored,
 WorkflowValues.TagPolicy onTag)

The inverse of encode(java.lang.Object, java.lang.String, com.axelor.workflow.expression.WorkflowValues.HostPolicy). onTag is asked about unknown tags, such as a variable's record reference, and answers UNHANDLED for one that is not its. A tag nobody knows is returned as its map.