org.mym.plog.formatter

Class DefaultFormatter

java.lang.Object

org.mym.plog.formatter.DefaultFormatter

All Implemented Interfaces:

Formatter

public class DefaultFormatter
extends Object
implements Formatter

Default implementation for Formatter, provide all supported types.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultFormatter.FormatFlag

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_FMT_JSON
static int	FLAG_FMT_POJO
static int	FLAG_FMT_THROWABLE

Constructor Summary

Constructors

Constructor and Description
DefaultFormatter() Create a formatter with all supported type format enabled.
DefaultFormatter(int... enabledTypes) Create a formatter which only support specified types.

Method Summary

Modifier and Type	Method and Description
String	format(String msg, Object... params) Format msg with params and return.

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_FMT_JSON

public static final int FLAG_FMT_JSON

See Also:

Constant Field Values

FLAG_FMT_POJO

public static final int FLAG_FMT_POJO

See Also:

Constant Field Values

FLAG_FMT_THROWABLE

public static final int FLAG_FMT_THROWABLE

See Also:

Constant Field Values

Constructor Detail

DefaultFormatter

public DefaultFormatter()

Create a formatter with all supported type format enabled.

DefaultFormatter

public DefaultFormatter(int... enabledTypes)

Create a formatter which only support specified types.

Parameters:

enabledTypes - types to format.

Method Detail

format

public String format(String msg,
                     Object... params)
              throws Exception

Description copied from interface: Formatter

Format msg with params and return.

NOTE VERY IMPORTANT: Sub implementation can decide whether discard one or more arguments, so make sure you are using right Formatter in right usage.

Specified by:

format in interface Formatter

Parameters:

msg - msg to be formatted. If this is null or empty but params provided, params still should be formatted.

params - params to format msg. maybe empty.

Returns:

formatted msg.

Throws:

Exception - any type of Exception can be thrown by implementation when format failed.