Package com.api.jsonata4java.expressions.functions

Class AbsFunction

java.lang.Object

com.api.jsonata4java.expressions.functions.FunctionBase

com.api.jsonata4java.expressions.functions.AbsFunction

public class AbsFunction
extends FunctionBase

Returns the absolute value of the number parameter, i.e. if the number is negative, it returns the positive value.

http://docs.jsonata.org/numeric-functions.html
$abs(number)
If number is not specified (i.e. this function is invoked with no arguments), then the context value is used as the value of number.

Examples:
$abs(5)==5
$abs(-5)==5

NOTE: FROM THE java.math::abs() FUNCTION JAVADOC:
Note that if the argument is equal to the value of Long.MIN_VALUE, the most negative representable long value, the result is that same value, which is negative.

Nested Class Summary

Nested classes/interfaces inherited from class com.api.jsonata4java.expressions.functions.FunctionBase

FunctionBase.CtxEvalResult

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERR_ARG1BADTYPE
static String	ERR_ARG2BADTYPE
static String	ERR_BAD_CONTEXT

Constructor Summary

Constructors

Constructor	Description
AbsFunction()

Method Summary

Modifier and Type	Method	Description
int	getMaxArgs()
int	getMinArgs()
String	getSignature()
com.fasterxml.jackson.databind.JsonNode	invoke(ExpressionsVisitor expressionVisitor, MappingExpressionParser.Function_callContext ctx)

Methods inherited from class com.api.jsonata4java.expressions.functions.FunctionBase

evalContext, getArgumentCount, getFunctionName

Methods inherited from class java.lang.Object

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

Field Details

ERR_BAD_CONTEXT

public static String ERR_BAD_CONTEXT

ERR_ARG1BADTYPE

public static String ERR_ARG1BADTYPE

ERR_ARG2BADTYPE

public static String ERR_ARG2BADTYPE

Constructor Details

AbsFunction

public AbsFunction()

Method Details

invoke

public com.fasterxml.jackson.databind.JsonNode invoke(ExpressionsVisitor expressionVisitor,
 MappingExpressionParser.Function_callContext ctx)

Specified by:

invoke in class FunctionBase

getMaxArgs

public int getMaxArgs()

Specified by:

getMaxArgs in class FunctionBase

getMinArgs

public int getMinArgs()

Specified by:

getMinArgs in class FunctionBase

getSignature

public String getSignature()

Specified by:

getSignature in class FunctionBase