cn.featherfly.common.lang.string

Class StringFormatter

java.lang.Object

cn.featherfly.common.lang.string.StringFormatter

public class StringFormatter
extends java.lang.Object

StringFormatter.

Constructor Summary

Constructors

Constructor and Description
StringFormatter(char startSymbol, char endSymbol) Instantiates a new custom string formatter.
StringFormatter(char startSymbol, char endSymbol, boolean placeholderAutoIndex) Instantiates a new custom string formatter.

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(java.lang.String str, java.util.Map<java.lang.String,java.lang.Object> args) format str.
<O> java.lang.String	format(java.lang.String str, O args) format str.
java.lang.String	format(java.lang.String str, java.lang.Object... args) format str.
char	getEndSymbol() 返回endSymbol.
char	getStartSymbol() 返回startSymbol.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringFormatter

public StringFormatter(char startSymbol,
                       char endSymbol)

Instantiates a new custom string formatter.

Parameters:

startSymbol - the start symbol

endSymbol - the end symbol

StringFormatter

public StringFormatter(char startSymbol,
                       char endSymbol,
                       boolean placeholderAutoIndex)

Instantiates a new custom string formatter.

Parameters:

startSymbol - the start symbol

endSymbol - the end symbol

placeholderAutoIndex - the placeholder auto index
if true auto add index to params placeholder, such as:
"hello {} at {} from [{1}] at {}"
"hello {0} at {1} from [{1}] at {2}"

Method Detail

getStartSymbol

public char getStartSymbol()

返回startSymbol.

Returns:

startSymbol

getEndSymbol

public char getEndSymbol()

返回endSymbol.

Returns:

endSymbol

format

public java.lang.String format(java.lang.String str,
                               java.lang.Object... args)

format str.

 StringFormatter formatter = new StringFormatter('{', '}');
 formatter.format("my name is {0}, i am {1} years old", new Object[] { "yufei", 18 });
 

Parameters:

str - format string

args - format args

Returns:

formated str

format

public java.lang.String format(java.lang.String str,
                               java.util.Map<java.lang.String,java.lang.Object> args)

format str.

 StringFormatter formatter = new StringFormatter('{', '}');
 formatter.format("my name is {name}, i am {age} years old",
         new HashChainMap<String, Object>().putChain("name", "yufei").putChain("age", 18));
 

Parameters:

str - format string

args - format args

Returns:

formated str

format

public <O> java.lang.String format(java.lang.String str,
                                   O args)

format str.

 User user = new User();
 user.setName("yufei");
 user.setAge(18);
 StringFormatter formatter = new StringFormatter('{', '}');
 formatter.format("my name is {name}, i am {age} years old", user);
 

Type Parameters:

O - the generic type

Parameters:

str - format string

args - format args

Returns:

formated str