Package org.apache.fop.util.text

Class AdvancedMessageFormat

java.lang.Object

org.apache.fop.util.text.AdvancedMessageFormat

public class AdvancedMessageFormat
extends Object

Formats messages based on a template and with a set of named parameters. This is similar to MessageFormat but uses named parameters and supports conditional sub-groups.

Example:

Missing field "{fieldName}"[ at location: {location}]!

• Curly brackets ("{}") are used for fields.
• Square brackets ("[]") are used to delimit conditional sub-groups. A sub-group is conditional when all fields inside the sub-group have a null value. In the case, everything between the brackets is skipped.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	AdvancedMessageFormat.CompositePart
static interface	AdvancedMessageFormat.Function	Implementations of this interface do some computation based on the message parameters given to it.
private static class	AdvancedMessageFormat.FunctionPart
static interface	AdvancedMessageFormat.ObjectFormatter	Implementations of this interface format certain objects to strings.
static interface	AdvancedMessageFormat.Part	Represents a message template part.
static interface	AdvancedMessageFormat.PartFactory	Implementations of this interface parse a field part and return message parts.
private static class	AdvancedMessageFormat.SimpleFieldPart
private static class	AdvancedMessageFormat.TextPart

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final Pattern	COMMA_SEPARATOR_REGEX	Regex that matches "," but not "\," (escaped comma)
private static final Map<Object,AdvancedMessageFormat.Function>	FUNCTIONS
private static final List<AdvancedMessageFormat.ObjectFormatter>	OBJECT_FORMATTERS
private static final Map<String,AdvancedMessageFormat.PartFactory>	PART_FACTORIES
private AdvancedMessageFormat.CompositePart	rootPart

Constructor Summary

Constructors

Constructor	Description
AdvancedMessageFormat(CharSequence pattern)	Construct a new message format.

Method Summary

Modifier and Type	Method	Description
String	format(Map<String,Object> params)	Formats a message with the given parameters.
void	format(Map<String,Object> params, StringBuffer target)	Formats a message with the given parameters.
static void	formatObject(Object obj, StringBuffer target)	Formats an object to a string and writes the result to a string buffer.
private static AdvancedMessageFormat.Function	getFunction(String functionName)
private AdvancedMessageFormat.Part	parseField(String field)
private int	parseInnerPattern(CharSequence pattern, AdvancedMessageFormat.CompositePart parent, StringBuffer sb, int start)
private void	parsePattern(CharSequence pattern)
(package private) static String	unescapeComma(String string)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMMA_SEPARATOR_REGEX

static final Pattern COMMA_SEPARATOR_REGEX

Regex that matches "," but not "\," (escaped comma)

PART_FACTORIES

private static final Map<String,AdvancedMessageFormat.PartFactory> PART_FACTORIES

OBJECT_FORMATTERS

private static final List<AdvancedMessageFormat.ObjectFormatter> OBJECT_FORMATTERS

FUNCTIONS

private static final Map<Object,AdvancedMessageFormat.Function> FUNCTIONS

rootPart

private AdvancedMessageFormat.CompositePart rootPart

Constructor Details

AdvancedMessageFormat

public AdvancedMessageFormat(CharSequence pattern)

Construct a new message format.

Parameters:

pattern - the message format pattern.

Method Details

parsePattern

private void parsePattern(CharSequence pattern)

parseInnerPattern

private int parseInnerPattern(CharSequence pattern,
 AdvancedMessageFormat.CompositePart parent,
 StringBuffer sb,
 int start)

parseField

private AdvancedMessageFormat.Part parseField(String field)

getFunction

private static AdvancedMessageFormat.Function getFunction(String functionName)

format

public String format(Map<String,Object> params)

Formats a message with the given parameters.

Parameters:

params - a Map of named parameters (Contents: <String, Object>)

Returns:

the formatted message

format

public void format(Map<String,Object> params,
 StringBuffer target)

Formats a message with the given parameters.

Parameters:

params - a Map of named parameters (Contents: <String, Object>)

target - the target StringBuffer to write the formatted message to

formatObject

public static void formatObject(Object obj,
 StringBuffer target)

Formats an object to a string and writes the result to a string buffer. This method usually uses the object's toString() method unless there is an AdvancedMessageFormat.ObjectFormatter that supports the object. AdvancedMessageFormat.ObjectFormatters are registered through the service provider mechanism defined by the JAR specification.

Parameters:

obj - the object to be formatted

target - the target string buffer

unescapeComma

static String unescapeComma(String string)