Interface FunctionTemplate

  • All Known Implementing Classes:
    StandardFunction

    public interface FunctionTemplate
    The FunctionTemplate interface describes responsibilities of a function template object. A function template is an object that helps create a family of similar functions that operate on different argument types.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Enum<?> getId()
      Returns the identifier of the operation functions instantiated from the template are associated with.
      Function instantiate​(DataType[] argTypes)
      Instantiates a function from the template for the given argument types.
    • Method Detail

      • getId

        java.lang.Enum<?> getId()
        Returns the identifier of the operation functions instantiated from the template are associated with.
        Returns:
        Operation identifier for the instantiated functions.
      • instantiate

        Function instantiate​(DataType[] argTypes)
        Instantiates a function from the template for the given argument types.
        Parameters:
        argTypes - Array of argument types.
        Returns:
        Function for the given argument types.
        Throws:
        java.lang.IllegalArgumentException - if the parameter equals null; if the function cannot be instantiated for the given arguments (wrong number, wrong types, etc.).