Package org.faktorips.fl.functions

Class AbstractBaseVarArgFunction<T extends org.faktorips.codegen.CodeFragment>

java.lang.Object

org.faktorips.fl.FunctionSignatureImpl

org.faktorips.fl.functions.AbstractBaseFlFunction<T>

org.faktorips.fl.functions.AbstractBaseVarArgFunction<T>

All Implemented Interfaces:

FlFunction<T>, FunctionSignature

Direct Known Subclasses:

AbstractVarArgFunction

public abstract class AbstractBaseVarArgFunction<T extends org.faktorips.codegen.CodeFragment>
extends AbstractBaseFlFunction<T>

An extension of the AbstractBaseFlFunction that provides base functionality for variable argument functions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_MESSAGE_CODE

Constructor Summary

Constructors

Constructor	Description
AbstractBaseVarArgFunction(String name, String description, org.faktorips.datatype.Datatype type, org.faktorips.datatype.Datatype argType)	Creates a new AbstractBaseVarArgFunction.
AbstractBaseVarArgFunction(String name, String description, FunctionSignatures signature)	Creates a new AbstractBaseVarArgFunction.

Method Summary

Modifier and Type	Method	Description
protected abstract void	compileInternal(CompilationResult<T> returnValue, CompilationResult<T>[] convertedArgs, T fragment)	The actual compile logic for this function has to be implemented within this method.
protected org.faktorips.datatype.Datatype	getExpectedDatatypeForArgResultConversion(CompilationResult<T>[] argResults)	Returns the expected Datatype used to convert arguments in a varargs statement to a common Datatype.

Methods inherited from class org.faktorips.fl.functions.AbstractBaseFlFunction

getCompiler, getDescription, setCompiler, setDescription

Methods inherited from class org.faktorips.fl.FunctionSignatureImpl

getArgTypes, getName, getType, hasVarArgs, isSame, match, matchUsingConversion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.faktorips.fl.FlFunction

compile

Methods inherited from interface org.faktorips.fl.FunctionSignature

getArgTypes, getName, getType, hasVarArgs, isSame, match, matchUsingConversion

Field Details

ERROR_MESSAGE_CODE

public static final String ERROR_MESSAGE_CODE

See Also:

• Constant Field Values

Constructor Details

AbstractBaseVarArgFunction

public AbstractBaseVarArgFunction(String name,
 String description,
 FunctionSignatures signature)

Creates a new AbstractBaseVarArgFunction.

See Also:

• the super class constructor parameter descripton for more details.

AbstractBaseVarArgFunction

public AbstractBaseVarArgFunction(String name,
 String description,
 org.faktorips.datatype.Datatype type,
 org.faktorips.datatype.Datatype argType)

Creates a new AbstractBaseVarArgFunction.

See Also:

• the super class constructor parameter descripton for more details.

Method Details

getExpectedDatatypeForArgResultConversion

protected org.faktorips.datatype.Datatype getExpectedDatatypeForArgResultConversion(CompilationResult<T>[] argResults)

Returns the expected Datatype used to convert arguments in a varargs statement to a common Datatype. This default implementation returns the Datatype defined for the first argument in the expression signature.

Parameters:

argResults - the results of the compilation of the individual parameters; may be used by subclasses to infer a Datatype.

Returns:

the expected Datatype

compileInternal

protected abstract void compileInternal(CompilationResult<T> returnValue,
 CompilationResult<T>[] convertedArgs,
 T fragment)

The actual compile logic for this function has to be implemented within this method. The called provides the CompilationResult that will be returned by this function, an array of already converted arguments and a CodeFragment into which the code is to be generated. The compilation result is provided to this method to write error messages that may occur during the code generation or to get status information. Implementations don't need to care about shoveling messages from the argument CompilationResult object to the returned CompilationResult object. This is already handled by the caller.