org.mule.util
Class TemplateParser

java.lang.Object
  extended by org.mule.util.TemplateParser

public final class TemplateParser
extends java.lang.Object

TemplateParser is a simple string parser that will substitute tokens in a string with values supplied in a Map.


Nested Class Summary
static class TemplateParser.PatternInfo
           
static interface TemplateParser.TemplateCallback
           
 
Field Summary
static java.util.regex.Pattern ANT_TEMPLATE_PATTERN
           
static java.lang.String ANT_TEMPLATE_STYLE
           
static java.util.regex.Pattern CURLY_TEMPLATE_PATTERN
           
static java.lang.String CURLY_TEMPLATE_STYLE
           
protected static Log logger
          logger used by this class
static java.util.regex.Pattern SQUARE_TEMPLATE_PATTERN
           
static java.lang.String SQUARE_TEMPLATE_STYLE
           
static java.util.regex.Pattern WIGGLY_MULE_TEMPLATE_PATTERN
           
static java.lang.String WIGGLY_MULE_TEMPLATE_STYLE
           
 
Method Summary
static TemplateParser createAntStyleParser()
           
static TemplateParser createCurlyBracesStyleParser()
           
static TemplateParser createMuleStyleParser()
           
static TemplateParser createSquareBracesStyleParser()
           
 TemplateParser.PatternInfo getStyle()
           
 boolean isContainsTemplate(java.lang.String value)
           
 boolean isValid(java.lang.String expression)
           
 java.util.List parse(java.util.Map props, java.util.List templates)
          Matches one or more templates against a Map of key value pairs.
 java.util.Map parse(java.util.Map props, java.util.Map templates)
          Matches one or more templates against a Map of key value pairs.
 java.lang.String parse(java.util.Map props, java.lang.String template)
          Matches one or more templates against a Map of key value pairs.
protected  java.lang.String parse(java.util.Map props, java.lang.String template, TemplateParser.TemplateCallback callback)
           
 java.util.Map parse(TemplateParser.TemplateCallback callback, java.util.Map templates)
           
 java.lang.String parse(TemplateParser.TemplateCallback callback, java.lang.String template)
          Matches one or more templates against a Map of key value pairs.
 void validate(java.lang.String expression)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ANT_TEMPLATE_STYLE

public static final java.lang.String ANT_TEMPLATE_STYLE
See Also:
Constant Field Values

SQUARE_TEMPLATE_STYLE

public static final java.lang.String SQUARE_TEMPLATE_STYLE
See Also:
Constant Field Values

CURLY_TEMPLATE_STYLE

public static final java.lang.String CURLY_TEMPLATE_STYLE
See Also:
Constant Field Values

WIGGLY_MULE_TEMPLATE_STYLE

public static final java.lang.String WIGGLY_MULE_TEMPLATE_STYLE
See Also:
Constant Field Values

logger

protected static final Log logger
logger used by this class


ANT_TEMPLATE_PATTERN

public static final java.util.regex.Pattern ANT_TEMPLATE_PATTERN

SQUARE_TEMPLATE_PATTERN

public static final java.util.regex.Pattern SQUARE_TEMPLATE_PATTERN

CURLY_TEMPLATE_PATTERN

public static final java.util.regex.Pattern CURLY_TEMPLATE_PATTERN

WIGGLY_MULE_TEMPLATE_PATTERN

public static final java.util.regex.Pattern WIGGLY_MULE_TEMPLATE_PATTERN
Method Detail

createAntStyleParser

public static TemplateParser createAntStyleParser()

createSquareBracesStyleParser

public static TemplateParser createSquareBracesStyleParser()

createCurlyBracesStyleParser

public static TemplateParser createCurlyBracesStyleParser()

createMuleStyleParser

public static TemplateParser createMuleStyleParser()

parse

public java.lang.String parse(java.util.Map props,
                              java.lang.String template)
Matches one or more templates against a Map of key value pairs. If a value for a template is not found in the map the template is left as is in the return String

Parameters:
props - the key/value pairs to match against
template - the string containing the template place holders i.e. My name is ${name}
Returns:
the parsed String

parse

public java.lang.String parse(TemplateParser.TemplateCallback callback,
                              java.lang.String template)
Matches one or more templates against a Map of key value pairs. If a value for a template is not found in the map the template is left as is in the return String

Parameters:
callback - a callback used to resolve the property name
template - the string containing the template place holders i.e. My name is ${name}
Returns:
the parsed String

parse

protected java.lang.String parse(java.util.Map props,
                                 java.lang.String template,
                                 TemplateParser.TemplateCallback callback)

parse

public java.util.List parse(java.util.Map props,
                            java.util.List templates)
Matches one or more templates against a Map of key value pairs. If a value for a template is not found in the map the template is left as is in the return String

Parameters:
props - the key/value pairs to match against
templates - A List of templates
Returns:
the parsed String

parse

public java.util.Map parse(java.util.Map props,
                           java.util.Map templates)
Matches one or more templates against a Map of key value pairs. If a value for a template is not found in the map the template is left as is in the return String

Parameters:
props - the key/value pairs to match against
templates - A Map of templates. The values for each map entry will be parsed
Returns:
the parsed String

parse

public java.util.Map parse(TemplateParser.TemplateCallback callback,
                           java.util.Map templates)

getStyle

public TemplateParser.PatternInfo getStyle()

isContainsTemplate

public boolean isContainsTemplate(java.lang.String value)

isValid

public boolean isValid(java.lang.String expression)

validate

public void validate(java.lang.String expression)
              throws java.lang.IllegalArgumentException
Throws:
java.lang.IllegalArgumentException


Copyright © 2003-2010 MuleSoft, Inc.. All Rights Reserved.