Package com.ibm.icu.samples.text.messagepattern

Class MiniMessageFormatter

java.lang.Object

com.ibm.icu.samples.text.messagepattern.MiniMessageFormatter

All Implemented Interfaces:

Freezable<MiniMessageFormatter>, Cloneable

public final class MiniMessageFormatter
extends Object
implements Freezable<MiniMessageFormatter>

Mini message formatter for a small subset of the ICU MessageFormat syntax. Supports only string substitution and select formatting.

Since:

2010-aug-21

Field Summary

Fields

Modifier and Type	Field	Description
private final MessagePattern	msg

Constructor Summary

Constructors

Constructor	Description
MiniMessageFormatter()
MiniMessageFormatter(MessagePattern msg)
MiniMessageFormatter(String msg)

Method Summary

Modifier and Type	Method	Description
MiniMessageFormatter	applyPattern(String msg)
MiniMessageFormatter	cloneAsThawed()	Provides for the clone operation.
private int	format(int msgStart, Appendable dest, Object[] args, Map<String,Object> argsMap)
Appendable	format(Appendable dest, Object... args)	Formats the parsed message with positional arguments.
Appendable	format(Appendable dest, Map<String,Object> argsMap)
static final String	format(String msg, Object... args)
static final String	format(String msg, Map<String,Object> argsMap)
MiniMessageFormatter	freeze()	Freezes the object.
String	getPatternString()
boolean	hasNamedArguments()
boolean	hasNumberedArguments()
boolean	isFrozen()	Determines whether the object has been frozen or not.
static Map<String,Object>	mapFromNameValuePairs(Object[] args)	Presents an array of (String, Object) pairs as a Map.

Methods inherited from class java.lang.Object

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

Field Details

msg

private final MessagePattern msg

Constructor Details

MiniMessageFormatter

public MiniMessageFormatter()

MiniMessageFormatter

public MiniMessageFormatter(MessagePattern msg)

MiniMessageFormatter

public MiniMessageFormatter(String msg)

Method Details

applyPattern

public MiniMessageFormatter applyPattern(String msg)

getPatternString

public String getPatternString()

hasNamedArguments

public boolean hasNamedArguments()

hasNumberedArguments

public boolean hasNumberedArguments()

format

public Appendable format(Appendable dest,
 Object... args)

Formats the parsed message with positional arguments. Supports only string substitution (e.g., {3}) and select format.

Parameters:

dest - gets the formatted message appended

args - positional arguments

Returns:

dest

format

public static final String format(String msg,
 Object... args)

format

public Appendable format(Appendable dest,
 Map<String,Object> argsMap)

format

public static final String format(String msg,
 Map<String,Object> argsMap)

format

private int format(int msgStart,
 Appendable dest,
 Object[] args,
 Map<String,Object> argsMap)

mapFromNameValuePairs

public static Map<String,Object> mapFromNameValuePairs(Object[] args)

Presents an array of (String, Object) pairs as a Map. Only for temporary use for formatting with named arguments.

cloneAsThawed

public MiniMessageFormatter cloneAsThawed()

Description copied from interface: Freezable

Provides for the clone operation. Any clone is initially unfrozen.

Specified by:

cloneAsThawed in interface Freezable<MiniMessageFormatter>

freeze

public MiniMessageFormatter freeze()

Description copied from interface: Freezable

Freezes the object.

Specified by:

freeze in interface Freezable<MiniMessageFormatter>

Returns:

the object itself.

isFrozen

public boolean isFrozen()

Description copied from interface: Freezable

Determines whether the object has been frozen or not.

Specified by:

isFrozen in interface Freezable<MiniMessageFormatter>