Class Capitalize
java.lang.Object
com.aquima.interactions.expressions.functions.str.Capitalize
- All Implemented Interfaces:
IFunction
,Serializable
This function capitalizes an input string and optionally lowers the rest of the characters
- Since:
- 9.6
- Author:
- g.graat
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic String
capitalize
(String input, boolean lowerTheRest) Capitalizes the first character of a String and lowercases the other characters if askeddetermineResultType
(ISemanticNode... arguments) This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.evaluate
(IArgumentList arguments) This method should execute the function using the supplied arguments.This method returns an array containing the definitions of the arguments the function expects.getName()
This method returns the name of the function.boolean
This method returns a boolean indicating that the function is deprecated and should no longer be used.
-
Constructor Details
-
Capitalize
public Capitalize() -
Capitalize
public Capitalize(boolean lowerTheRest)
-
-
Method Details
-
getArguments
Description copied from interface:IFunction
This method returns an array containing the definitions of the arguments the function expects. When the function does not accept any arguments at all, an empty array should be returned.- Specified by:
getArguments
in interfaceIFunction
- Returns:
- Array containing the definitions of the parameters.
-
evaluate
Description copied from interface:IFunction
This method should execute the function using the supplied arguments. -
getName
Description copied from interface:IFunction
This method returns the name of the function. -
determineResultType
Description copied from interface:IFunction
This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.- Specified by:
determineResultType
in interfaceIFunction
- Parameters:
arguments
- The type information of the parameters.- Returns:
- The result type of the function.
-
isDeprecated
public boolean isDeprecated()Description copied from interface:IFunction
This method returns a boolean indicating that the function is deprecated and should no longer be used. Functions that are not deprecated should return the value false.- Specified by:
isDeprecated
in interfaceIFunction
- Returns:
- A message indicating that the function is deprecated.
-
capitalize
Capitalizes the first character of a String and lowercases the other characters if asked- Parameters:
input
- String to be capitalizedlowerTheRest
- indicates if the other characters need to be lowercased or not- Returns:
- capitalized String
-