TokenParser (T-Plan Robot Enterprise 7.0 Code Documentation)

All Known Implementing Classes:

TokenParserImpl
```
public interface TokenParser
```
Token parser is responsible for breaking down individual test commands into elements representing the command name, arguments and parameters.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields
Modifier and Type Field and Description

static String FILE_PATH_SEPARATOR
Common OS-independent file path separator.

Fields
Modifier and Type	Field and Description
`static String`	`FILE_PATH_SEPARATOR` Common OS-independent file path separator.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`buttonToString(int button)` Convert a `MouseEvent` button constant to a TPR string one.
`String`	`colorArrayToString(Color[] c)` Convert an array of colors to a semicolon separated list of HTML-style color representation.
`String`	`colorToString(Color c)` Convert color to HTML-style RGB string.
`String`	`dimensionToString(Dimension d)` Convert dimensions to a string.
`Object`	`evaluateNumericExpression(String expression, Class resultType)` Evaluate a numeric or boolean expression.
`Object`	`evaluateNumericExpression(String expression, Class resultType, ScriptingContext context)` Evaluate a numeric or boolean expression.
`String`	`fileListToString(File[] files)` Convert a list of files to the semicolon separated string format understood by TPR scripts.
`String`	`fileListToString(File[] files, File defaultPath)` Convert a list of files to the semicolon separated string format understood by TPR scripts.
`String`	`fileListToString(File[] files, File defaultPath, boolean forceRelative)` Convert a list of files to the semicolon separated string format understood by TPR scripts.
`ExpressionEvaluator`	`getEvaluator()` Get the numeric and boolean expression evaluator.
`String`	`modifiersToString(int modifiers)` Convert extended key event modifiers to the TPR format.
`Map<String,String>`	`parse(String params)` Parse the argument string into a map of [param, value] pairs.
`Map<String,String>`	`parse(String params, List<String> v)` Parse the argument string into a map of [param, value] pairs.
`Map<String,String>`	`parse(String params, List<String> v, boolean throwExceptionOnErrors, int[] errorOffset)` Parse the argument string for parameters and parameter-value pairs.
`Map<String,String>`	`parse(String params, List<String> v, boolean throwExceptionOnErrors, int[] errorOffset, boolean originalValues)` Parse the argument string for parameters and parameter-value pairs.
`Map<String,String>`	`parse(String params, List<String> v, List<int[]> l)`
`LinkedHashMap<String,Object>`	`parse2map(String command)`
`Boolean`	`parseBoolean(Object obj, String paramName)` Parse a boolean number.
`Color`	`parseColor(String s)` Parse an HTML-style RGB color.
`Color[]`	`parseColorArray(String s)` Parse a list of semicolon separated colors in the HTML format.
`String`	`parseCommandName(String command)` Get the command name (the first word) from the argument command line.
`Dimension`	`parseDimension(Object obj, Dimension defaults, String paramName, ScriptingContext ctx)` Parse dimension (the [width, height] value pair) from the argument object.
`File[]`	`parseFileList(String fileList)` Parse file list from the TPR semicolon separated format.
`File[]`	`parseFileList(String fileList, File defaultPath)` Parse file list from the TPR semicolon separated format.
`List<String>`	`parseForValues(String values)` Parse a white space separated list of values (tokens).
`Number`	`parseInteger(Object obj, String paramName)` Parse an integer number.
`Number`	`parseInteger(Object obj, String paramName, ScriptingContext ctx)` Parse an integer number.
`int`	`parseKeyLocation(String location)` Convert TPR specified key location to the `KeyEvent` one.
`int`	`parseModifiers(String modifiers)` Parse the key modifiers.
`int`	`parseMouseButton(String button)` Parse the mouse button.
`Number`	`parseNumber(Object obj, String paramName)` Parse a number.
`Number`	`parseNumber(Object obj, String paramName, ScriptingContext ctx)` Parse a number.
`Map<String,String>`	`parseParameters(String command)` Parse parameters from a command line.
`Map<String,String>`	`parseParameters(String command, List v)` Parse parameters from a command line.
`Map<String,String>`	`parseParameters(String command, List v, boolean returnOriginalValues)` Parse parameters from a command line.
`String`	`parseParameterString(String command)` Get the parameter substring from a command line.
`Number`	`parsePercentage(Object obj, String paramName)` Parse a percentage such as "23.5%".
`Number`	`parsePercentage(Object obj, String paramName, ScriptingContext ctx)` Parse a number which may be terminated with a percent sign '%'.
`RelativePoint`	`parsePoint(Object obj, String paramName)` Parse a point from the argument object.
`RelativePoint`	`parsePoint(Object obj, String paramName, ScriptingContext ctx)` Parse a point from the argument object.
`Map<String,String>`	`parsePointParams(String s, String paramName)` Parse point parameters from the argument object.
`Rectangle`	`parseRectangle(Object obj, Rectangle defaults, String paramName)` Parse a rectangle from the argument object.
`Rectangle`	`parseRectangle(Object obj, Rectangle defaults, String paramName, ScriptingContext ctx)` Parse a rectangle from the argument object.
`Rectangle`	`parseRectangle(Object obj, String paramName)` Parse a rectangle from the argument object.
`Map<String,String>`	`parseRectangleParams(String s, String paramName)` Parse rectangle parameters from the argument object.
`Number`	`parseTime(Object obj, String paramName)` Parse time from a string.The method always returns the time value in milliseconds.
`Number`	`parseTime(Object obj, String paramName, Object[] components)` Parse time from a string.The method always returns the time value in milliseconds.
`Number`	`parseTime(Object obj, String paramName, Object[] components, ScriptingContext ctx)` Parse a time value.
`String`	`pointToString(Point p)` Convert the argument point to a string.
`String`	`readToken(char[] ca, int beg)` This will read a string in quotes or just a single string.Reading stops when the final quote is reached (quoted string) or when a space or equal sign is reached (unquoted string).
`String`	`rectToString(Rectangle r)` Convert the argument rectangle to a string.

- Field Detail
  - FILE_PATH_SEPARATOR
```
static final String FILE_PATH_SEPARATOR
```
    Common OS-independent file path separator.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - parse
```
Map<String,String> parse(String params)
```
    Parse the argument string into a map of [param, value] pairs.
    
    Parameters:
    
    params - a string containing parameters.
    
    Returns:
    
    the map of [param, value] pairs.
  - readToken
```
String readToken(char[] ca,
                 int beg)
```
    This will read a string in quotes or just a single string.Reading stops when the final quote is reached (quoted string) or when a space or equal sign is reached (unquoted string).
    
    Examples:
    - for string 'test test' the method returns 'test'
    - for string '"test test" test' the method returns '"test test"'
    - for string 'test=blabla' the method return 'test'
    - for string '"test \"test\""=5' the method returns '"test \"test\""'
    Parameters:
    
    ca - the input string characters.
    
    beg - the start offset.
    
    Returns:
    
    the first token or null if the end of string is reached
  - parse
```
Map<String,String> parse(String params,
                         List<String> v)
```
    Parse the argument string into a map of [param, value] pairs.
    
    Parameters:
    
    params - a string containing parameters.
    
    v - optional list to store the parameter names to. The parameters will be stored in the same order as they are parsed.
    
    Returns:
    
    the map of [param, value] pairs.
  - parse
```
Map<String,String> parse(String params,
                         List<String> v,
                         boolean throwExceptionOnErrors,
                         int[] errorOffset)
```
    Parse the argument string for parameters and parameter-value pairs.
    
    Parameters:
    
    params - the string to parse.
    
    v - a list to store the parameter names to.
    
    throwExceptionOnErrors - whether to throw an error on syntax error, for example on an unescaped or a missing enclosing double quote.
    
    errorOffset - optional output array of length=1 to store the index of the error to. It is used only when throwExceptionOnErrors is true.
    
    Returns:
    
    a map of parameter names and values.
    
    Since:
    
    3.1.1
  - parse
```
Map<String,String> parse(String params,
                         List<String> v,
                         boolean throwExceptionOnErrors,
                         int[] errorOffset,
                         boolean originalValues)
```
    Parse the argument string for parameters and parameter-value pairs.
    
    Parameters:
    
    params - the string to parse.
    
    v - a list to store the parameter names to.
    
    throwExceptionOnErrors - whether to throw an error on syntax error, for example on an unescaped or a missing enclosing double quote.
    
    errorOffset - optional output array of length=1 to store the index of the error to. It is used only when throwExceptionOnErrors is true.
    
    originalValues - a flag indicating whether to fix obvious errors in the values such as unescaped quotes.
    
    Returns:
    
    a map of parameter names and values.
  - parse
```
Map<String,String> parse(String params,
                         List<String> v,
                         List<int[]> l)
```
  - parse2map
```
LinkedHashMap<String,Object> parse2map(String command)
```
  - parseNumber
```
Number parseNumber(Object obj,
                   String paramName)
            throws SyntaxErrorException
```
    Parse a number.
    
    Parameters:
    
    obj - the value to parse.
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    the parsed value.
    
    Throws:
    
    SyntaxErrorException - when the value is not a number.
  - parseNumber
```
Number parseNumber(Object obj,
                   String paramName,
                   ScriptingContext ctx)
            throws SyntaxErrorException
```
    Parse a number.
    
    Parameters:
    
    obj - the value to parse.
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    ctx - scripting context (optional). This parameter is available since the 2.3.3 release. If the context is not null and it is a compilation one, the method reports no error when the value contains one or more calls of variables which are not known.
    
    Returns:
    
    the parsed value.
    
    Throws:
    
    SyntaxErrorException - when the value is not a number or the context is an execution one and the value contains an unresolved variable call.
  - parseInteger
```
Number parseInteger(Object obj,
                    String paramName)
             throws SyntaxErrorException
```
    Parse an integer number.
    
    Parameters:
    
    obj - the value to parse.
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    the parsed value.
    
    Throws:
    
    SyntaxErrorException - when the value is not an integer.
  - parseInteger
```
Number parseInteger(Object obj,
                    String paramName,
                    ScriptingContext ctx)
             throws SyntaxErrorException
```
    Parse an integer number.
    
    Parameters:
    
    obj - the value to parse.
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    ctx - scripting context (optional). This parameter is available since the 2.3.3 release. If the context is not null and it is a compilation one, the method reports no error when the value contains one or more calls of variables which are not known.
    
    Returns:
    
    the parsed value.
    
    Throws:
    
    SyntaxErrorException - when the value is not an integer or the context is an execution one and the value contains an unresolved variable call.
  - parseBoolean
```
Boolean parseBoolean(Object obj,
                     String paramName)
              throws SyntaxErrorException
```
    Parse a boolean number.
    
    Parameters:
    
    obj - the value to parse.
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    the parsed value.
    
    Throws:
    
    SyntaxErrorException - when the value is not a boolean.
  - parsePercentage
```
Number parsePercentage(Object obj,
                       String paramName)
                throws SyntaxErrorException
```
    Parse a percentage such as "23.5%".
    
    Parameters:
    
    obj - the value to parse.
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    the parsed number.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid percentage.
  - parsePercentage
```
Number parsePercentage(Object obj,
                       String paramName,
                       ScriptingContext ctx)
                throws SyntaxErrorException
```
    Parse a number which may be terminated with a percent sign '%'.
    
    Parameters:
    
    obj - the value to parse.
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    ctx - scripting context (optional). This parameter is available since the 2.3.3 release. If the context is not null and it is a compilation one, the method reports no error when the value contains one or more calls of variables which are not known.
    
    Returns:
    
    the parsed value.
    
    Throws:
    
    SyntaxErrorException - when the value is not a number or the context is an execution one and the value contains an unresolved variable call.
  - parseTime
```
Number parseTime(Object obj,
                 String paramName)
          throws SyntaxErrorException
```
    Parse time from a string.The method always returns the time value in milliseconds.
    
    Parameters:
    
    obj - an object containing time (it may be a String or Number). See the parseTime(java.lang.Object, java.lang.String, java.lang.Object[], com.tplan.robot.scripting.ScriptingContext) method for details on the supported time formats.
    
    paramName - parameter name (to be mentioned in the eventually thrown exception)
    
    Returns:
    
    time in milliseconds
    
    Throws:
    
    SyntaxErrorException - when the argument has a wrong syntax.
    
    NumberFormatException - when the string doesn't comply with the format.
  - parseTime
```
Number parseTime(Object obj,
                 String paramName,
                 Object[] components)
          throws SyntaxErrorException
```
    Parse time from a string.The method always returns the time value in milliseconds.
    
    Parameters:
    
    obj - an object containing time (it may be a String or Number). See the parseTime(java.lang.Object, java.lang.String, java.lang.Object[], com.tplan.robot.scripting.ScriptingContext) method for details on the supported time formats.
    
    paramName - parameter name (to be mentioned in the eventually thrown exception)
    
    components - optional input-output array (length=3 or higher) to store the parsed number (components[0]), time unit (components[1]) and the unit factor used to convert the number to milliseconds (components[2]).
    
    Returns:
    
    time in milliseconds
    
    Throws:
    
    SyntaxErrorException - on a syntax error.
    
    NumberFormatException - when the string doesn't comply with the format.
  - parseTime
```
Number parseTime(Object obj,
                 String paramName,
                 Object[] components,
                 ScriptingContext ctx)
          throws SyntaxErrorException
```
    Parse a time value. Supported formats are:
    - '5' = 5 ms
    - '5s' = 5 seconds = 5000 ms
    - '5m' = 5 minutes = 5*60*1000 ms
    - '5h' = 5 hours = 5*60*60*1000 ms
    - '5d' = 5 days = 5*24*60*60*1000 ms
    The format characters are case sensitive.
    Parameters:
    
    obj - the value to parse.
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    components - optional input-output array (length=3 or higher) to store the parsed number (components[0]), time unit (components[1]) and the unit factor used to convert the number to milliseconds (components[2]).
    
    ctx - scripting context (optional). This parameter is available since the 2.3.3 release. If the context is not null and it is a compilation one, the method reports no error when the value contains one or more calls of variables which are not known.
    
    Returns:
    
    the parsed value.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid time value or the context is an execution one and the value contains an unresolved variable call.
  - parsePointParams
```
Map<String,String> parsePointParams(String s,
                                    String paramName)
                             throws SyntaxErrorException
```
    Parse point parameters from the argument object.
    
    Parameters:
    
    s - a value to parse from, for example "x:0,y:36".
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    a map of the coordinates (x,y) and their values.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid point.
  - parsePoint
```
RelativePoint parsePoint(Object obj,
                         String paramName)
                  throws SyntaxErrorException
```
    Parse a point from the argument object.
    
    Parameters:
    
    obj - a value to parse from, for example "x:0,y:36".
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    a relative point instance with the specified coordinates.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid point.
  - parsePoint
```
RelativePoint parsePoint(Object obj,
                         String paramName,
                         ScriptingContext ctx)
                  throws SyntaxErrorException
```
    Parse a point from the argument object.
    
    Parameters:
    
    obj - a value to parse from, for example "x:0,y:36".
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    ctx - a script context.
    
    Returns:
    
    a relative point instance with the specified coordinates.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid point.
  - parseRectangleParams
```
Map<String,String> parseRectangleParams(String s,
                                        String paramName)
                                 throws SyntaxErrorException
```
    Parse rectangle parameters from the argument object.
    
    Parameters:
    
    s - a value to parse from, for example "x:0,y:0,w:100,h:100".
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    a map of the coordinates (x,y,w,h) and their values.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid rectangle.
  - parseRectangle
```
Rectangle parseRectangle(Object obj,
                         Rectangle defaults,
                         String paramName)
                  throws SyntaxErrorException
```
    Parse a rectangle from the argument object.
    
    Parameters:
    
    obj - a value to parse from, for example "x:0,y:0,w:100,h:100".
    
    defaults - optional screen dimensions. They are used to evaluate percentage values. For example, if "defaults=x:0,y:0,w:600,h:800" and the argument rectangle is "x:10%,y:0,w:50%,h:800" it will be resolved as "x:60,y:0,w:300,h:800".
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    the parsed rectangle.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid rectangle. variable call.
  - parseRectangle
```
Rectangle parseRectangle(Object obj,
                         Rectangle defaults,
                         String paramName,
                         ScriptingContext ctx)
                  throws SyntaxErrorException
```
    Parse a rectangle from the argument object.
    
    Parameters:
    
    obj - a value to parse from, for example "x:0,y:0,w:100,h:100".
    
    defaults - optional screen dimensions. They are used to evaluate percentage values. For example, if "defaults=x:0,y:0,w:600,h:800" and the argument rectangle is "x:10%,y:0,w:50%,h:800" it will be resolved as "x:60,y:0,w:300,h:800".
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    ctx - scripting context (optional). This parameter is available since the 2.3.3 release. If the context is not null and it is a compilation one, the method reports no error when the value contains one or more calls of variables which are not known.
    
    Returns:
    
    the parsed rectangle.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid rectangle or the context is an execution one and the value contains an unresolved variable call.
  - parseRectangle
```
Rectangle parseRectangle(Object obj,
                         String paramName)
                  throws SyntaxErrorException
```
    Parse a rectangle from the argument object.
    
    Parameters:
    
    obj - a value to parse from, for example "x:0,y:0,w:100,h:100".
    
    paramName - parameter name (optional). If it is specified and parsing fails the method will throw an exception saying something like "Parameter 'paramname' parsing failed".
    
    Returns:
    
    the parsed rectangle.
    
    Throws:
    
    SyntaxErrorException - when the value is not a valid rectangle. variable call.
  - parseDimension
```
Dimension parseDimension(Object obj,
                         Dimension defaults,
                         String paramName,
                         ScriptingContext ctx)
                  throws SyntaxErrorException
```
    Parse dimension (the [width, height] value pair) from the argument object.
    
    Parameters:
    
    obj - an object to parse from.
    
    defaults - the default dimensions to use if the argument object uses percentages.
    
    paramName - name of the parameter (will be used in the text of eventually thrown exception).
    
    ctx - a context (optional).
    
    Returns:
    
    the parsed dimensions.
    
    Throws:
    
    SyntaxErrorException - when the argument object does not represent valid dimensions.
    
    Since:
    
    4.0
  - parseMouseButton
```
int parseMouseButton(String button)
              throws SyntaxErrorException
```
    Parse the mouse button.
    Parameters:
    button - the button to parse. The TPR language supports three button types which will be parsed as follows:
    
    "left" will be converted to MouseEvent.BUTTON1,
    
    "middle" will be converted to MouseEvent.BUTTON2,
    
    "right" will be converted to MouseEvent.BUTTON3.
    Returns:
    
    the MouseEvent compliant mouse button code.
    
    Throws:
    
    SyntaxErrorException - when the argument is not a valid button type.
  - parseModifiers
```
int parseModifiers(String modifiers)
            throws SyntaxErrorException
```
    Parse the key modifiers.
    Parameters:
    modifiers - the value to parse. The TPR language supports three modifiers which will be parsed as follows:
    
    "alt" will be converted to InputEvent.ALT_MASK,
    
    "shift" will be converted to InputEvent.SHIFT_MASK,
    
    "ctrl" will be converted to InputEvent.CTRL_MASK.
    
    If there are two or more modifiers the return value will be a bit mask of the modifier constants. For example, "alt+shift" will return InputEvent.ALT_MASK | InputEvent.SHIFT_MASK.
    Returns:
    
    the InputEvent compatible modifier mask.
    
    Throws:
    
    SyntaxErrorException - when the argument is not a valid modifier or a combination of modifiers.
  - rectToString
```
String rectToString(Rectangle r)
```
    Convert the argument rectangle to a string.
    
    Parameters:
    
    r - a rectangle.
    
    Returns:
    
    the string representation of the argument.
  - dimensionToString
```
String dimensionToString(Dimension d)
```
    Convert dimensions to a string.
    
    Parameters:
    
    d - dimensions.
    
    Returns:
    
    the string representation of the argument.
    
    Since:
    
    4.0
  - pointToString
```
String pointToString(Point p)
```
    Convert the argument point to a string.
    
    Parameters:
    
    p - the point to convert to string.
    
    Returns:
    
    the string representation of the argument.
  - parseCommandName
```
String parseCommandName(String command)
```
    Get the command name (the first word) from the argument command line.
    
    Parameters:
    
    command - a command line (command plus arguments and parameters).
    
    Returns:
    
    the command name.
  - parseParameterString
```
String parseParameterString(String command)
```
    Get the parameter substring from a command line.
    
    Parameters:
    
    command - a command line (command plus arguments and parameters).
    
    Returns:
    
    part of the line that contains arguments and parameters.
  - parseParameters
```
Map<String,String> parseParameters(String command)
```
    Parse parameters from a command line.
    
    Parameters:
    
    command - a command line (command plus arguments and parameters).
    
    Returns:
    
    a map of parameter names and their values.
  - parseParameters
```
Map<String,String> parseParameters(String command,
                                   List v)
```
    Parse parameters from a command line.
    
    Parameters:
    
    command - a command line (command plus arguments and parameters).
    
    v - if not null it will be populated with the parameter names in the order they are parsed.
    
    Returns:
    
    a map of parameter names and their values.
  - parseParameters
```
Map<String,String> parseParameters(String command,
                                   List v,
                                   boolean returnOriginalValues)
```
    Parse parameters from a command line.
    
    Parameters:
    
    command - a command line (command plus arguments and parameters).
    
    v - if not null it will be populated with the parameter names in the order they are parsed.
    
    returnOriginalValues - a flag indicating whether to fix obvious errors in the values such as unescaped quotes.
    
    Returns:
    
    a map of parameter names and their values.
  - evaluateNumericExpression
```
Object evaluateNumericExpression(String expression,
                                 Class resultType,
                                 ScriptingContext context)
```
    Evaluate a numeric or boolean expression.
    
    Parameters:
    
    expression - a numeric or a boolean expression.
    
    resultType - the desired result type such as Boolean.class, Double.class or Integer.class.
    
    context - a script context.
    
    Returns:
    
    the result.
  - evaluateNumericExpression
```
Object evaluateNumericExpression(String expression,
                                 Class resultType)
```
    Evaluate a numeric or boolean expression.
    
    Parameters:
    
    expression - a numeric or a boolean expression.
    
    resultType - the desired result type such as Boolean.class, Double.class or Integer.class.
    
    Returns:
    
    the result.
  - modifiersToString
```
String modifiersToString(int modifiers)
```
    Convert extended key event modifiers to the TPR format.
    
    Parameters:
    
    modifiers - modifiers returned by InputEvent.getModifiersEx().
    
    Returns:
    
    the corresponding string format such as "Ctrl+Alt".
  - parseKeyLocation
```
int parseKeyLocation(String location)
              throws SyntaxErrorException
```
    Convert TPR specified key location to the KeyEvent one.
    
    Parameters:
    
    location - a TPR location constant, one of "location, standard, numpad, left".
    
    Returns:
    
    the corresponding KeyEvent location constant.
    
    Throws:
    
    SyntaxErrorException - on an unknown argument.
  - buttonToString
```
String buttonToString(int button)
```
    Convert a MouseEvent button constant to a TPR string one.
    
    Parameters:
    
    button - a button returned by MouseEvent.getButton().
    
    Returns:
    
    the TPR button constant, one of "left, middle, right".
  - fileListToString
```
String fileListToString(File[] files,
                        File defaultPath,
                        boolean forceRelative)
```
    Convert a list of files to the semicolon separated string format understood by TPR scripts.
    
    Parameters:
    
    files - one or more file paths.
    
    defaultPath - if populated the method converts files to relative paths.
    
    forceRelative - if true and the default path is provided the method will convert all file paths to relative ones. If false and the path is provided it will convert to relative only files contained within that path.
    
    Returns:
    
    the TPR file format.
  - fileListToString
```
String fileListToString(File[] files,
                        File defaultPath)
```
    Convert a list of files to the semicolon separated string format understood by TPR scripts.
    
    Parameters:
    
    files - one or more file paths.
    
    defaultPath - if populated the method converts files contained within that path to relative paths.
    
    Returns:
    
    the TPR file format.
  - fileListToString
```
String fileListToString(File[] files)
```
    Convert a list of files to the semicolon separated string format understood by TPR scripts.
    
    Parameters:
    
    files - one or more file paths.
    
    Returns:
    
    the TPR file format with absolute paths.
  - parseFileList
```
File[] parseFileList(String fileList)
```
    Parse file list from the TPR semicolon separated format.
    
    Parameters:
    
    fileList - a TPR file list.
    
    Returns:
    
    the list of files.
  - parseFileList
```
File[] parseFileList(String fileList,
                     File defaultPath)
```
    Parse file list from the TPR semicolon separated format.
    
    Parameters:
    
    fileList - a TPR file list.
    
    defaultPath - if provided then any relative paths in the argument list will be resolved against it.
    
    Returns:
    
    the list of files.
  - colorToString
```
String colorToString(Color c)
```
    Convert color to HTML-style RGB string. The returned value will be 6 characters long, with R, G, B color components encoded in this order as lower case hexadecimal values (2 characters each).
    
    Parameters:
    
    c - a color.
    
    Returns:
    
    HTML-style RGB string or empty string when the argument color is null.
  - colorArrayToString
```
String colorArrayToString(Color[] c)
```
    Convert an array of colors to a semicolon separated list of HTML-style color representation.
    
    Parameters:
    
    c - a color array.
    
    Returns:
    
    the string representation of the color array. See the colorToString(java.awt.Color) method for details on the color format.
  - parseColor
```
Color parseColor(String s)
```
    Parse an HTML-style RGB color.
    
    Parameters:
    
    s - HTM-style color argument. Each of the R, G, B components must be specified as 2-character hexadecimal number in this specific order. The string may be optionally prefixed with the hash character '#'. Examples of valid colors are "ffffff" or "#ffffff" (white), "ff0000" or "#ff0000" (red), "000000" or "#000000" (black) etc. If the argument doesn't meet the required format, the method throws an IllegalArgumentException.
    
    Returns:
    
    parsed Color instance.
  - parseColorArray
```
Color[] parseColorArray(String s)
```
    Parse a list of semicolon separated colors in the HTML format.
    
    Parameters:
    
    s - semicolon separated list of colors. See the parseColor(java.lang.String) method for details on the color format.
    
    Returns:
    
    an array of colors.
  - parseForValues
```
List<String> parseForValues(String values)
```
    Parse a white space separated list of values (tokens). A token containing spaces must be enclosed in escaped double quotes. Any double escaped double quote will be converted to a double quote. For example, an argument like "USA \"South Africa\" \"\" \"United Kingdom (\\\"UK\\\")\"" will produce [ "USA", "South Africa", "", "United Kingdom (\"UK\")" ].
    
    This method was introduced in 3.0.1 to support conversion of the TPR 'for' statement iterating over a set of values to Java.
    
    Parameters:
    
    values - a list of values.
    
    Returns:
    
    the list of parsed tokens.
  - getEvaluator
```
ExpressionEvaluator getEvaluator()
```
    Get the numeric and boolean expression evaluator.
    
    Returns:
    
    the expression evaluator.
    
    Since:
    
    4.4.7

Interface TokenParser

Field Summary

Method Summary

Field Detail

FILE_PATH_SEPARATOR

Method Detail

parse

readToken

parse

parse

parse

parse

parse2map

parseNumber

parseNumber

parseInteger

parseInteger

parseBoolean

parsePercentage

parsePercentage

parseTime

parseTime

parseTime

parsePointParams

parsePoint

parsePoint

parseRectangleParams

parseRectangle

parseRectangle

parseRectangle

parseDimension

parseMouseButton

parseModifiers

rectToString

dimensionToString

pointToString

parseCommandName

parseParameterString

parseParameters

parseParameters

parseParameters

evaluateNumericExpression

evaluateNumericExpression

modifiersToString

parseKeyLocation

buttonToString

fileListToString

fileListToString

fileListToString

parseFileList

parseFileList

colorToString

colorArrayToString

parseColor

parseColorArray

parseForValues

getEvaluator