Class ToLowerCase

  • All Implemented Interfaces:
    Function

    public class ToLowerCase
    extends java.lang.Object
    implements Function
    This class is a function that executes within Evaluator. The function returns the source string in lower case. See the String.toLowerCase() method in the JDK for a complete description of how this function works.
    • Constructor Summary

      Constructors 
      Constructor Description
      ToLowerCase()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      FunctionResult execute​(Evaluator evaluator, java.lang.String arguments)
      Executes the function for the specified argument.
      java.lang.String getName()
      Returns the name of the function - "toLowerCase".
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ToLowerCase

        public ToLowerCase()
    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of the function - "toLowerCase".
        Specified by:
        getName in interface Function
        Returns:
        The name of this function class.
      • execute

        public FunctionResult execute​(Evaluator evaluator,
                                      java.lang.String arguments)
                               throws FunctionException
        Executes the function for the specified argument. This method is called internally by Evaluator.
        Specified by:
        execute in interface Function
        Parameters:
        evaluator - An instance of Evaluator.
        arguments - A string argument that will be converted into one string argument. The string argument(s) HAS to be enclosed in quotes. White space that is not enclosed within quotes will be trimmed. Quote characters in the first and last positions of any string argument (after being trimmed) will be removed also. The quote characters used must be the same as the quote characters used by the current instance of Evaluator. If there are multiple arguments, they must be separated by a comma (",").
        Returns:
        The source string, converted to lowercase.
        Throws:
        FunctionException - if the argument(s) are not valid for this function