ANTAREX API

Clava API

LARA API

LARA Common Language API

Global Functions

checkArray

checkArray(variable, source)

Parameters

variable: any
source: any

checkBoolean

checkBoolean(variable, source)

Parameters

variable: any
source: any

checkDefined

checkDefined(value, varName, source)

Parameters

value: any
varName: any
source: any

checkInstance

checkInstance(value, type, source, userTypeName)

Parameters

value: any
type: any
source: any
userTypeName: any

checkNumber

checkNumber(variable, source)

Parameters

variable: any
source: any

checkString

checkString(variable, source)

Parameters

variable: any
source: any

checkTrue

checkTrue(booleanExpr, message, source)

Throws an exception if the given expression evaluates to false.

Parameters

booleanExpr: any
message: any
source: any

checkType

checkType(value, type, source)

Parameters

value: any
type: any
source: any

defaultValue

defaultValue(value, defaultValue)

Returns the value if defined or the provided default value. This useful for optional parameters of functions.

Parameters

value: any - the original value
defaultValue: any - the default value

isArray

isArray(value)

Parameters

value: any

Returns

any - true if the given value is an array, false otherwise

isDebug

isDebug()

isUndefined

isUndefined(value)

Temporary method that returns true if the given value is undefined or null,
to be used while WeaverGenerator does not support returning undefined from Java.

Parameters

value: any

notImplemented

notImplemented(functionName)

Parameters

functionName: any

setDebug

setDebug(value)

Parameters

value: any