Class MiniMessageFormatter
- java.lang.Object
-
- com.ibm.icu.samples.text.messagepattern.MiniMessageFormatter
-
- All Implemented Interfaces:
Freezable<MiniMessageFormatter>
,java.lang.Cloneable
public final class MiniMessageFormatter extends java.lang.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 MessagePattern
msg
-
Constructor Summary
Constructors Constructor Description MiniMessageFormatter()
MiniMessageFormatter(MessagePattern msg)
MiniMessageFormatter(java.lang.String msg)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MiniMessageFormatter
applyPattern(java.lang.String msg)
MiniMessageFormatter
cloneAsThawed()
Provides for the clone operation.private int
format(int msgStart, java.lang.Appendable dest, java.lang.Object[] args, java.util.Map<java.lang.String,java.lang.Object> argsMap)
java.lang.Appendable
format(java.lang.Appendable dest, java.lang.Object... args)
Formats the parsed message with positional arguments.java.lang.Appendable
format(java.lang.Appendable dest, java.util.Map<java.lang.String,java.lang.Object> argsMap)
static java.lang.String
format(java.lang.String msg, java.lang.Object... args)
static java.lang.String
format(java.lang.String msg, java.util.Map<java.lang.String,java.lang.Object> argsMap)
MiniMessageFormatter
freeze()
Freezes the object.java.lang.String
getPatternString()
boolean
hasNamedArguments()
boolean
hasNumberedArguments()
boolean
isFrozen()
Determines whether the object has been frozen or not.static java.util.Map<java.lang.String,java.lang.Object>
mapFromNameValuePairs(java.lang.Object[] args)
Presents an array of (String, Object) pairs as a Map.
-
-
-
Field Detail
-
msg
private final MessagePattern msg
-
-
Constructor Detail
-
MiniMessageFormatter
public MiniMessageFormatter()
-
MiniMessageFormatter
public MiniMessageFormatter(MessagePattern msg)
-
MiniMessageFormatter
public MiniMessageFormatter(java.lang.String msg)
-
-
Method Detail
-
applyPattern
public MiniMessageFormatter applyPattern(java.lang.String msg)
-
getPatternString
public java.lang.String getPatternString()
-
hasNamedArguments
public boolean hasNamedArguments()
-
hasNumberedArguments
public boolean hasNumberedArguments()
-
format
public java.lang.Appendable format(java.lang.Appendable dest, java.lang.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 appendedargs
- positional arguments- Returns:
- dest
-
format
public static final java.lang.String format(java.lang.String msg, java.lang.Object... args)
-
format
public java.lang.Appendable format(java.lang.Appendable dest, java.util.Map<java.lang.String,java.lang.Object> argsMap)
-
format
public static final java.lang.String format(java.lang.String msg, java.util.Map<java.lang.String,java.lang.Object> argsMap)
-
format
private int format(int msgStart, java.lang.Appendable dest, java.lang.Object[] args, java.util.Map<java.lang.String,java.lang.Object> argsMap)
-
mapFromNameValuePairs
public static java.util.Map<java.lang.String,java.lang.Object> mapFromNameValuePairs(java.lang.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 interfaceFreezable<MiniMessageFormatter>
-
freeze
public MiniMessageFormatter freeze()
Description copied from interface:Freezable
Freezes the object.- Specified by:
freeze
in interfaceFreezable<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 interfaceFreezable<MiniMessageFormatter>
-
-