Interface ITextParser
-
- All Superinterfaces:
com4j.Com4jObject
public interface ITextParser extends com4j.Com4jObject
Utilities for handling parameters in a string.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clearParam(Object vParam)
Clear the parameter - Set its value to null.int
count()
Gets the number of parameters.void
evaluateText()
Converts the parameters to their values.void
initialize(String startClose, String endClose, String typeClose, int maxLen, String defaultType)
Initializes the parser.boolean
paramExist(String paramName)
Checks if a parameter with the specified name exists.String
paramName(int nPosition)
Gets the parameter name.String
paramType(Object vParam)
Gets the user-defined Parameter Type.String
paramValue(Object vParam)
The parameter value.void
paramValue(Object vParam, String pVal)
The parameter value.String
text()
The text to be parsed.void
text(String pVal)
The text to be parsed.int
type(Object vParam)
Gets the Parameter Type - predefined, null, or regular.
-
-
-
Method Detail
-
count
int count()
Gets the number of parameters.
Getter method for the COM property "Count"
- Returns:
- Returns a value of type int
-
paramValue
String paramValue(Object vParam)
The parameter value.
Getter method for the COM property "ParamValue"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.- Returns:
- Returns a value of type java.lang.String
-
paramValue
void paramValue(Object vParam, String pVal)
The parameter value.
Setter method for the COM property "ParamValue"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.pVal
- Mandatory java.lang.String parameter.
-
clearParam
void clearParam(Object vParam)
Clear the parameter - Set its value to null.
- Parameters:
vParam
- Mandatory java.lang.Object parameter.
-
type
int type(Object vParam)
Gets the Parameter Type - predefined, null, or regular.
Getter method for the COM property "Type"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.- Returns:
- Returns a value of type int
-
paramType
String paramType(Object vParam)
Gets the user-defined Parameter Type.
Getter method for the COM property "ParamType"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.- Returns:
- Returns a value of type java.lang.String
-
paramExist
boolean paramExist(String paramName)
Checks if a parameter with the specified name exists.
Getter method for the COM property "ParamExist"
- Parameters:
paramName
- Mandatory java.lang.String parameter.- Returns:
- Returns a value of type boolean
-
paramName
String paramName(int nPosition)
Gets the parameter name.
Getter method for the COM property "ParamName"
- Parameters:
nPosition
- Mandatory int parameter.- Returns:
- Returns a value of type java.lang.String
-
initialize
void initialize(@DefaultValue("<%") String startClose, @DefaultValue("%>") String endClose, @DefaultValue("?") String typeClose, @DefaultValue("-1") int maxLen, @DefaultValue("string") String defaultType)
Initializes the parser.
- Parameters:
startClose
- Optional parameter. Default value is "<%"endClose
- Optional parameter. Default value is "%>"typeClose
- Optional parameter. Default value is "?"maxLen
- Optional parameter. Default value is -1defaultType
- Optional parameter. Default value is "string"
-
text
void text(String pVal)
The text to be parsed.
Setter method for the COM property "Text"
- Parameters:
pVal
- Mandatory java.lang.String parameter.
-
text
String text()
The text to be parsed.
Getter method for the COM property "Text"
- Returns:
- Returns a value of type java.lang.String
-
evaluateText
void evaluateText()
Converts the parameters to their values.
-
-