org.gvsig.expressionevaluator.impl.function.programming

Class ReturnFunction

java.lang.Object

org.gvsig.expressionevaluator.spi.AbstractFunction

org.gvsig.expressionevaluator.impl.function.programming.ReturnFunction

All Implemented Interfaces:

Function

public class ReturnFunction
extends AbstractFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReturnFunction.ReturnException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from class org.gvsig.expressionevaluator.spi.AbstractFunction

LOGGER, TYPE_BIGDECIMAL, TYPE_BOOLEAN, TYPE_DATE, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT, TYPE_LONG, TYPE_NULL, TYPE_STRING

Fields inherited from interface org.gvsig.expressionevaluator.Function

GROUP_AGGREGATE, GROUP_BOOLEAN, GROUP_CONVERSION, GROUP_DATETIME, GROUP_NUMERIC, GROUP_OGC, GROUP_OTHER, GROUP_PROGRAMMING, GROUP_STRING

Constructor Summary

Constructors

Constructor and Description
ReturnFunction()

Method Summary

Modifier and Type	Method and Description
boolean	allowConstantFolding() Returns true if the function always returns the same value for the same parameters.
java.lang.Object	call(Interpreter interpreter, java.lang.Object[] args)
boolean	isHidden()
java.lang.String	toString(Codes args, Formatter<Code> formatter)

Methods inherited from class org.gvsig.expressionevaluator.spi.AbstractFunction

addAlias, aliases, argc, call, checkDoubleValue, checkFloatValue, description, descriptionArgs, getBigDecimal, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getComparable, getComparable, getDate, getDate, getDouble, getDouble, getFile, getFile, getFloat, getFloat, getFullDescription, getInt, getInt, getInt, getJsonArray, getJsonArray, getJsonObject, getJsonObject, getJsonStructure, getJsonStructure, getList, getLocalDateTime, getLocalDateTime, getLong, getLong, getObject, getObject, getStr, getStr, getType, getURL, group, isNull, isOperator, isSQLCompatible, name, returnType, template, toBoolean, toString, toValue, useArgumentsInsteadObjects

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

ReturnFunction

public ReturnFunction()

Method Detail

isHidden

public boolean isHidden()

Specified by:

isHidden in interface Function

Overrides:

isHidden in class AbstractFunction

allowConstantFolding

public boolean allowConstantFolding()

Description copied from interface: Function

Returns true if the function always returns the same value for the same parameters. If so, it is possible to optimize the generated code through the process of "constant folding". https://en.wikipedia.org/wiki/Constant_folding

Specified by:

allowConstantFolding in interface Function

Overrides:

allowConstantFolding in class AbstractFunction

Returns:

true if this function allow constant folding optimization.

call

public java.lang.Object call(Interpreter interpreter,
                             java.lang.Object[] args)
                      throws java.lang.Exception

Throws:

java.lang.Exception

toString

public java.lang.String toString(Codes args,
                                 Formatter<Code> formatter)

Specified by:

toString in interface Function

Overrides:

toString in class AbstractFunction