Package org.faktorips.fl

Interface FunctionSignature

All Known Subinterfaces:
FlFunction<T>
All Known Implementing Classes:
Abs, AbstractBaseFlFunction, AbstractBaseVarArgFunction, AbstractFlFunction, AbstractIf, AbstractListFunction, AbstractPeriodFunction, AbstractVarArgFunction, And, Count, Date, Days, Days360, Exists, FunctionSignatureImpl, If, IfBoolean, IsEmpty, MinMaxComparableDatatypes, MinMaxDecimal, MinMaxDouble, MinMaxInt, MinMaxList, MinMaxLong, MinMaxMoney, MinMaxNativeTypes, Months, Not, NotBoolean, Or, PowerDecimal, PowerInt, Round, SqrtDecimal, SumBeanArrayPropertyFct, SumDecimal, SumList, TextFunction, Weeks, WholeNumber, Years
public interface FunctionSignature
Interface that defines a function's signature. The function signature may contain a variable argument list. If so all arguments must be of the same Datatype. See the description of the getArgTypes() method for more details.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.faktorips.datatype.Datatype[]
    getArgTypes()
    Returns the function's arguments' types.
    String
    getName()
    Returns the function's name.
    org.faktorips.datatype.Datatype
    getType()
    Returns the function's return type.
    boolean
    hasVarArgs()
    Indicates if this function has a variable argument list.
    boolean
    isSame(FunctionSignature fctSignature)
    Returns true if the given fctSignature is the same as this one.
    boolean
    match(String name, org.faktorips.datatype.Datatype[] argTypes)
    Returns true if this function signature has the indicated name and argument types.
    boolean
    matchUsingConversion(String name, org.faktorips.datatype.Datatype[] argTypes, org.faktorips.datatype.ConversionMatrix matrix)
    Returns true if this function signature has the indicated name and if each given argument type is either equal to this function's argument type or can be convert to it.

  • Method Details

    • getType

      org.faktorips.datatype.Datatype getType()
      Returns the function's return type.

    • getName

      String getName()
      Returns the function's name.

    • getArgTypes

      org.faktorips.datatype.Datatype[] getArgTypes()
      Returns the function's arguments' types. If the function has variable arguments the returned array is of length 1 and contains the Datatype that is valid for all arguments of this function.

    • isSame

      boolean isSame(FunctionSignature fctSignature)
      Returns true if the given fctSignature is the same as this one. This is the case if they have the same type, name and the arguments' types are the same (in the same order).

    • hasVarArgs

      boolean hasVarArgs()
      Indicates if this function has a variable argument list. If so the return value of the getArgTyes() method is an array of lenght 1 and contains the Datatype that is valid for all arguments of this function.

    • match

      boolean match(String name, org.faktorips.datatype.Datatype[] argTypes)
      Returns true if this function signature has the indicated name and argument types.

    • matchUsingConversion

      boolean matchUsingConversion(String name, org.faktorips.datatype.Datatype[] argTypes, org.faktorips.datatype.ConversionMatrix matrix)
      Returns true if this function signature has the indicated name and if each given argument type is either equal to this function's argument type or can be convert to it.