Package org.apache.struts2.util
Class TextParseUtil
java.lang.Object
org.apache.struts2.util.TextParseUtil
Utility class for text parsing.
- Author:
- Jason Carreira, Rainer Hermanns, tm_jee
- 
Nested Class SummaryNested Classes
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionReturns a set from comma delimited Strings.static ObjecttranslateVariables(char[] openChars, String expression, ValueStack stack, Class asType, TextParseUtil.ParsedValueEvaluator evaluator) Converted object from variable translation.static ObjecttranslateVariables(char[] openChars, String expression, ValueStack stack, Class asType, TextParseUtil.ParsedValueEvaluator evaluator, int maxLoopCount) Converted object from variable translation.static StringtranslateVariables(char open, String expression, ValueStack stack) Converts all instances of ${...} inexpressionto the value returned by a call toValueStack.findValue(java.lang.String).static ObjecttranslateVariables(char open, String expression, ValueStack stack, Class asType) Converted object from variable translation.static ObjecttranslateVariables(char open, String expression, ValueStack stack, Class asType, TextParseUtil.ParsedValueEvaluator evaluator) Converted object from variable translation.static ObjecttranslateVariables(char open, String expression, ValueStack stack, Class asType, TextParseUtil.ParsedValueEvaluator evaluator, int maxLoopCount) Converted object from variable translation.static StringtranslateVariables(String expression, ValueStack stack) Converts all instances of ${...}, and %{...} inexpressionto the value returned by a call toValueStack.findValue(java.lang.String).static StringtranslateVariables(String expression, ValueStack stack, TextParseUtil.ParsedValueEvaluator evaluator) Function similarly astranslateVariables(char, String, ValueStack)except for the introduction of an additionalevaluatorthat allows the parsed value to be evaluated by theevaluator.static Collection<String>translateVariablesCollection(char[] openChars, String expression, ValueStack stack, boolean excludeEmptyElements, TextParseUtil.ParsedValueEvaluator evaluator, int maxLoopCount) Resolves given expression on given ValueStack.static Collection<String>translateVariablesCollection(String expression, ValueStack stack, boolean excludeEmptyElements, TextParseUtil.ParsedValueEvaluator evaluator) 
- 
Constructor Details- 
TextParseUtilpublic TextParseUtil()
 
- 
- 
Method Details- 
translateVariablesConverts all instances of ${...}, and %{...} inexpressionto the value returned by a call toValueStack.findValue(java.lang.String). If an item cannot be found on the stack (null is returned), then the entire variable ${...} is not displayed, just as if the item was on the stack but returned an empty string.- Parameters:
- expression- an expression that hasn't yet been translated
- stack- value stack
- Returns:
- the parsed expression
 
- 
translateVariablespublic static String translateVariables(String expression, ValueStack stack, TextParseUtil.ParsedValueEvaluator evaluator) Function similarly astranslateVariables(char, String, ValueStack)except for the introduction of an additionalevaluatorthat allows the parsed value to be evaluated by theevaluator. Theevaluatorcould be null, if it is it will just be skipped as if it is just callingtranslateVariables(char, String, ValueStack).
 A typical use-case would be when we need to URL Encode the parsed value. To do so we could just supply a URLEncodingEvaluator for example.- Parameters:
- expression- expression string
- stack- value stack
- evaluator- The parsed Value evaluator (could be null).
- Returns:
- the parsed (and possibly evaluated) variable String.
 
- 
translateVariablesConverts all instances of ${...} inexpressionto the value returned by a call toValueStack.findValue(java.lang.String). If an item cannot be found on the stack (null is returned), then the entire variable ${...} is not displayed, just as if the item was on the stack but returned an empty string.- Parameters:
- open- open character
- expression- expression string
- stack- value stack
- Returns:
- Translated variable String
 
- 
translateVariablespublic static Object translateVariables(char open, String expression, ValueStack stack, Class asType) Converted object from variable translation.- Parameters:
- open- open character
- expression- expression string
- stack- value stack
- asType- as class type
- Returns:
- Converted object from variable translation.
 
- 
translateVariablespublic static Object translateVariables(char open, String expression, ValueStack stack, Class asType, TextParseUtil.ParsedValueEvaluator evaluator) Converted object from variable translation.- Parameters:
- open- open character
- expression- expression string
- stack- value stack
- asType- as class type
- evaluator- value evaluator
- Returns:
- Converted object from variable translation.
 
- 
translateVariablespublic static Object translateVariables(char[] openChars, String expression, ValueStack stack, Class asType, TextParseUtil.ParsedValueEvaluator evaluator) Converted object from variable translation.- Parameters:
- openChars- open character array
- expression- expression string
- stack- value stack
- asType- as class type
- evaluator- value evaluator
- Returns:
- Converted object from variable translation.
 
- 
translateVariablespublic static Object translateVariables(char open, String expression, ValueStack stack, Class asType, TextParseUtil.ParsedValueEvaluator evaluator, int maxLoopCount) Converted object from variable translation.- Parameters:
- open- open character
- expression- expression string
- stack- value stack
- asType- as class type
- evaluator- value evaluator
- maxLoopCount- max loop count
- Returns:
- Converted object from variable translation.
 
- 
translateVariablespublic static Object translateVariables(char[] openChars, String expression, ValueStack stack, Class asType, TextParseUtil.ParsedValueEvaluator evaluator, int maxLoopCount) Converted object from variable translation.- Parameters:
- openChars- open character array
- expression- expression string
- stack- value stack
- asType- as class type
- evaluator- value evaluator
- maxLoopCount- max loop count
- Returns:
- Converted object from variable translation.
 
- 
translateVariablesCollectionpublic static Collection<String> translateVariablesCollection(String expression, ValueStack stack, boolean excludeEmptyElements, TextParseUtil.ParsedValueEvaluator evaluator) - Parameters:
- expression- expression string
- stack- value stack
- excludeEmptyElements- Whether empty elements shall be excluded.
- evaluator- value evaluator
- Returns:
- converted objects
- See Also:
 
- 
translateVariablesCollectionpublic static Collection<String> translateVariablesCollection(char[] openChars, String expression, ValueStack stack, boolean excludeEmptyElements, TextParseUtil.ParsedValueEvaluator evaluator, int maxLoopCount) Resolves given expression on given ValueStack. If found element is a collection each element will be converted to String. If just a single object is found it is converted to String and wrapped in a collection.- Parameters:
- openChars- open character array
- expression- expression string
- stack- value stack
- evaluator- value evaluator
- excludeEmptyElements- Whether empty elements shall be excluded.
- maxLoopCount- max loop count
- Returns:
- converted objects
 
- 
commaDelimitedStringToSetReturns a set from comma delimited Strings.- Parameters:
- s- The String to parse.
- Returns:
- A set from comma delimited Strings.
 
 
-