net.sourceforge.jeval.function.string
Class Replace

java.lang.Object
  extended by net.sourceforge.jeval.function.string.Replace
All Implemented Interfaces:
Function

public class Replace
extends java.lang.Object
implements Function

This class is a function that executes within Evaluator. The function returns a new string with all of the occurances of the old character in the source string replaced with the new character. See the String.replace(char, char) method in the JDK for a complete description of how this function works.


Constructor Summary
Replace()
           
 
Method Summary
 java.lang.String execute(Evaluator evaluator, java.lang.String arguments)
          Executes the function for the specified argument.
 java.lang.String getName()
          Returns the name of the function - "replace".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Replace

public Replace()
Method Detail

getName

public java.lang.String getName()
Returns the name of the function - "replace".

Specified by:
getName in interface Function
Returns:
The name of this function class.

execute

public java.lang.String 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 and two character arguments. The first argument is the source string to replace the charactes in. The second argument is the old character to replace in the source string. The third argument is the new character to replace the old character with in the source string. The string and character 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:
Returns a string with every occurence of the old character replaced with the new character.
Throws:
FunctionException - Thrown if the argument(s) are not valid for this function.


Copyright (C) 2002-2007 Robert Breidecker.