libGDX 1.14.2 · com.badlogic.gdx.utils.TextFormatter

Modifier and Type	Field and Description
private StringBuilder	buffer
private MessageFormat	messageFormat

Access	Constructor and Description
public	TextFormatter(Locale locale, boolean useMessageFormat)

Method Summary

Modifier and Type	Method and Description
public String	Returns: the formatted pattern format(String the pattern pattern, Object... the arguments args) Formats the given `pattern` replacing its placeholders with the actual arguments specified by `args`.
private String	replaceEscapeChars(String pattern)
private String	Returns: the formatted pattern simpleFormat(String the pattern pattern, Object... the arguments args) Formats the given `pattern` replacing any placeholder of the form {0}, {1}, {2} and so on with the corresponding object from `args` converted to a string with `toString()`, so without taking into account the locale.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

buffer	back to summary
private StringBuilder buffer

messageFormat	back to summary
private MessageFormat messageFormat

TextFormatter	back to summary
public TextFormatter(Locale locale, boolean useMessageFormat)

Method Detail

format back to summary

format	back to summary
public String format(String pattern, Object... args) Formats the given `pattern` replacing its placeholders with the actual arguments specified by `args`. If this `TextFormatter` has been instantiated with `TextFormatter(locale, true)` `MessageFormat` is used to process the pattern, meaning that the actual arguments are properly localized with the locale of this `TextFormatter`. On the contrary, if this `TextFormatter` has been instantiated with `TextFormatter(locale, false)` pattern's placeholders are expected to be in the simplified form {0}, {1}, {2} and so on and they will be replaced with the corresponding object from `args` converted to a string with `toString()`, so without taking into account the locale. In both cases, there's only one simple escaping rule, i.e. a left curly bracket must be doubled if you want it to be part of your string. It's worth noting that the rules for using single quotes within `MessageFormat` patterns have shown to be somewhat confusing. In particular, it isn't always obvious to localizers whether single quotes need to be doubled or not. For this very reason we decided to offer the simpler escaping rule above without limiting the expressive power of message format patterns. So, if you're used to MessageFormat's syntax, remember that with `TextFormatter` single quotes never need to be escaped! Parameters pattern:String the pattern args:Object[] the arguments Returns:String the formatted pattern Exceptions IllegalArgumentException: if the pattern is invalid

public String format(String pattern, Object... args)

Formats the given pattern replacing its placeholders with the actual arguments specified by args.

If this TextFormatter has been instantiated with TextFormatter(locale, true) MessageFormat is used to process the pattern, meaning that the actual arguments are properly localized with the locale of this TextFormatter.

On the contrary, if this TextFormatter has been instantiated with TextFormatter(locale, false) pattern's placeholders are expected to be in the simplified form {0}, {1}, {2} and so on and they will be replaced with the corresponding object from args converted to a string with toString(), so without taking into account the locale.

In both cases, there's only one simple escaping rule, i.e. a left curly bracket must be doubled if you want it to be part of your string.

It's worth noting that the rules for using single quotes within MessageFormat patterns have shown to be somewhat confusing. In particular, it isn't always obvious to localizers whether single quotes need to be doubled or not. For this very reason we decided to offer the simpler escaping rule above without limiting the expressive power of message format patterns. So, if you're used to MessageFormat's syntax, remember that with TextFormatter single quotes never need to be escaped!

Parameters

pattern:String: the pattern
args:Object[]: the arguments

Returns:String

the formatted pattern

Exceptions

IllegalArgumentException:: if the pattern is invalid

replaceEscapeChars	back to summary
private String replaceEscapeChars(String pattern)

simpleFormat back to summary

simpleFormat	back to summary
private String simpleFormat(String pattern, Object... args) Formats the given `pattern` replacing any placeholder of the form {0}, {1}, {2} and so on with the corresponding object from `args` converted to a string with `toString()`, so without taking into account the locale. This method only implements a small subset of the grammar supported by `java.text.MessageFormat`. Especially, placeholder are only made up of an index; neither the type nor the style are supported. If nothing has been replaced this implementation returns the pattern itself. Parameters pattern:String the pattern args:Object[] the arguments Returns:String the formatted pattern Exceptions IllegalArgumentException: if the pattern is invalid

private String simpleFormat(String pattern, Object... args)

Formats the given pattern replacing any placeholder of the form {0}, {1}, {2} and so on with the corresponding object from args converted to a string with toString(), so without taking into account the locale.

This method only implements a small subset of the grammar supported by java.text.MessageFormat. Especially, placeholder are only made up of an index; neither the type nor the style are supported.

If nothing has been replaced this implementation returns the pattern itself.

Parameters

pattern:String: the pattern
args:Object[]: the arguments

Returns:String

the formatted pattern

Exceptions

IllegalArgumentException:: if the pattern is invalid

pack-priv Class TextFormatter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail