com.elvishew.xlog

Class Logger.Builder

java.lang.Object

com.elvishew.xlog.Logger.Builder

Enclosing class:

Logger

public static class Logger.Builder
extends java.lang.Object

Builder for Logger.

Constructor Summary

Constructors

Constructor and Description
Builder() Construct a builder, which will perform the same as the global one by default.

Method Summary

Modifier and Type	Method and Description
Logger.Builder	addInterceptor(Interceptor interceptor) Add an interceptor when Logger logging.
<T> Logger.Builder	addObjectFormatter(java.lang.Class<T> objectClass, ObjectFormatter<? super T> objectFormatter) Add an object formatter for specific class of object when Logger log an object.
Logger.Builder	b() Deprecated. use enableBorder() instead, since 1.7.0
Logger.Builder	borderFormatter(BorderFormatter borderFormatter) Set the border formatter when Logger logging.
Logger	build() Builds configured Logger object.
void	d(java.lang.Object object) Convenience of build() and Logger.d(Object).
void	d(java.lang.Object[] array) Convenience of build() and Logger.d(Object[]).
void	d(java.lang.String msg) Convenience of build() and Logger.d(String).
void	d(java.lang.String format, java.lang.Object... args) Convenience of build() and Logger.d(String, Object...).
void	d(java.lang.String msg, java.lang.Throwable tr) Convenience of build() and Logger.d(String, Throwable).
Logger.Builder	disableBorder() Disable border, the log content won't be surrounded by a border.
Logger.Builder	disableStackTrace() Disable stack trace, the stack trace won't be printed with the log message.
Logger.Builder	disableThreadInfo() Disable thread info, the thread info won't be printed with the log message.
void	e(java.lang.Object object) Convenience of build() and Logger.e(Object).
void	e(java.lang.Object[] array) Convenience of build() and Logger.e(Object[]).
void	e(java.lang.String msg) Convenience of build() and Logger.e(String).
void	e(java.lang.String format, java.lang.Object... args) Convenience of build() and Logger.e(String, Object...).
void	e(java.lang.String msg, java.lang.Throwable tr) Convenience of build() and Logger.e(String, Throwable).
Logger.Builder	enableBorder() Enable border, the border would surround the entire log content, and separate the log message, thread info and stack trace.
Logger.Builder	enableStackTrace(int depth) Enable stack trace, the stack trace would be printed with the log message.
Logger.Builder	enableStackTrace(java.lang.String stackTraceOrigin, int depth) Enable stack trace, the stack trace would be printed with the log message.
Logger.Builder	enableThreadInfo() Enable thread info, the thread info would be printed with the log message.
void	i(java.lang.Object object) Convenience of build() and Logger.i(Object).
void	i(java.lang.Object[] array) Convenience of build() and Logger.i(Object[]).
void	i(java.lang.String msg) Convenience of build() and Logger.i(String).
void	i(java.lang.String format, java.lang.Object... args) Convenience of build() and Logger.i(String, Object...).
void	i(java.lang.String msg, java.lang.Throwable tr) Convenience of build() and Logger.i(String, Throwable).
void	json(java.lang.String json) Convenience of build() and Logger.json(String).
Logger.Builder	jsonFormatter(JsonFormatter jsonFormatter) Set the JSON formatter when Logger log a JSON string.
void	log(int logLevel, java.lang.Object object) Convenience of build() and Logger.log(int, Object).
void	log(int logLevel, java.lang.Object[] array) Convenience of build() and Logger.log(int, Object[]).
void	log(int logLevel, java.lang.String msg) Convenience of build() and Logger.log(int, String).
void	log(int logLevel, java.lang.String format, java.lang.Object... args) Convenience of build() and Logger.log(int, String, Object...).
void	log(int logLevel, java.lang.String msg, java.lang.Throwable tr) Convenience of build() and Logger.log(int, String, Throwable).
Logger.Builder	logLevel(int logLevel) Set the log level, the logs below of which would not be printed.
Logger.Builder	nb() Deprecated. use disableBorder() instead, since 1.7.0
Logger.Builder	nst() Deprecated. use disableStackTrace() instead, since 1.7.0
Logger.Builder	nt() Deprecated. use disableThreadInfo() instead, since 1.7.0
Logger.Builder	printers(Printer... printers) Set the printers used to print the log when Logger log.
Logger.Builder	st(int depth) Deprecated. use enableStackTrace(int) instead, since 1.7.0
Logger.Builder	st(java.lang.String stackTraceOrigin, int depth) Deprecated. use enableStackTrace(String, int) instead, since 1.7.0
Logger.Builder	stackTraceFormatter(StackTraceFormatter stackTraceFormatter) Set the stack trace formatter when Logger logging.
Logger.Builder	t() Deprecated. use enableThreadInfo() instead, since 1.7.0
Logger.Builder	tag(java.lang.String tag) Set the tag string when Logger log.
Logger.Builder	threadFormatter(ThreadFormatter threadFormatter) Set the thread formatter when Logger logging.
Logger.Builder	throwableFormatter(ThrowableFormatter throwableFormatter) Set the throwable formatter when Logger log a message with throwable.
void	v(java.lang.Object object) Convenience of build() and Logger.v(Object).
void	v(java.lang.Object[] array) Convenience of build() and Logger.v(Object[]).
void	v(java.lang.String msg) Convenience of build() and Logger.v(String).
void	v(java.lang.String format, java.lang.Object... args) Convenience of build() and Logger.v(String, Object...).
void	v(java.lang.String msg, java.lang.Throwable tr) Convenience of build() and Logger.v(String, Throwable).
void	w(java.lang.Object object) Convenience of build() and Logger.w(Object).
void	w(java.lang.Object[] array) Convenience of build() and Logger.w(Object[]).
void	w(java.lang.String msg) Convenience of build() and Logger.w(String).
void	w(java.lang.String format, java.lang.Object... args) Convenience of build() and Logger.w(String, Object...).
void	w(java.lang.String msg, java.lang.Throwable tr) Convenience of build() and Logger.w(String, Throwable).
void	xml(java.lang.String xml) Convenience of build() and Logger.xml(String).
Logger.Builder	xmlFormatter(XmlFormatter xmlFormatter) Set the XML formatter when Logger log a XML string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Construct a builder, which will perform the same as the global one by default.

Method Detail

logLevel

public Logger.Builder logLevel(int logLevel)

Set the log level, the logs below of which would not be printed.

Parameters:

logLevel - the log level

Returns:

the builder

Since:

1.3.0

tag

public Logger.Builder tag(java.lang.String tag)

Set the tag string when Logger log.

Parameters:

tag - the tag string when Logger log

Returns:

the builder

t

@Deprecated
public Logger.Builder t()

Deprecated. use enableThreadInfo() instead, since 1.7.0

Enable thread info.

Returns:

the builder

enableThreadInfo

public Logger.Builder enableThreadInfo()

Enable thread info, the thread info would be printed with the log message.

Returns:

the builder

Since:

1.7.0

See Also:

ThreadFormatter

nt

@Deprecated
public Logger.Builder nt()

Deprecated. use disableThreadInfo() instead, since 1.7.0

Disable thread info.

Returns:

the builder

disableThreadInfo

public Logger.Builder disableThreadInfo()

Disable thread info, the thread info won't be printed with the log message.

Returns:

the builder

Since:

1.7.0

st

@Deprecated
public Logger.Builder st(int depth)

Deprecated. use enableStackTrace(int) instead, since 1.7.0

Enable stack trace.

Parameters:

depth - the number of stack trace elements we should log, 0 if no limitation

Returns:

the builder

enableStackTrace

public Logger.Builder enableStackTrace(int depth)

Enable stack trace, the stack trace would be printed with the log message.

Parameters:

depth - the number of stack trace elements we should log, 0 if no limitation

Returns:

the builder

Since:

1.7.0

See Also:

StackTraceFormatter

st

@Deprecated
public Logger.Builder st(java.lang.String stackTraceOrigin,
                                     int depth)

Deprecated. use enableStackTrace(String, int) instead, since 1.7.0

Enable stack trace.

Parameters:

stackTraceOrigin - the origin of stack trace elements from which we should NOT log when logging with stack trace, it can be a package name like "com.elvishew.xlog", a class name like "com.yourdomain.logWrapper", or something else between package name and class name, like "com.yourdomain.". It is mostly used when you are using a logger wrapper

depth - the number of stack trace elements we should log, 0 if no limitation

Returns:

the builder

Since:

1.4.0

enableStackTrace

public Logger.Builder enableStackTrace(java.lang.String stackTraceOrigin,
                                       int depth)

Enable stack trace, the stack trace would be printed with the log message.

Parameters:

stackTraceOrigin - the origin of stack trace elements from which we should NOT log when logging with stack trace, it can be a package name like "com.elvishew.xlog", a class name like "com.yourdomain.logWrapper", or something else between package name and class name, like "com.yourdomain.". It is mostly used when you are using a logger wrapper

depth - the number of stack trace elements we should log, 0 if no limitation

Returns:

the builder

Since:

1.7.0

See Also:

StackTraceFormatter

nst

@Deprecated
public Logger.Builder nst()

Deprecated. use disableStackTrace() instead, since 1.7.0

Disable stack trace.

Returns:

the builder

disableStackTrace

public Logger.Builder disableStackTrace()

Disable stack trace, the stack trace won't be printed with the log message.

Returns:

the builder

Since:

1.7.0

See Also:

StackTraceFormatter

b

@Deprecated
public Logger.Builder b()

Deprecated. use enableBorder() instead, since 1.7.0

Enable border.

Returns:

the builder

enableBorder

public Logger.Builder enableBorder()

Enable border, the border would surround the entire log content, and separate the log message, thread info and stack trace.

Returns:

the builder

Since:

1.7.0

See Also:

BorderFormatter

nb

@Deprecated
public Logger.Builder nb()

Deprecated. use disableBorder() instead, since 1.7.0

Disable border.

Returns:

the builder

disableBorder

public Logger.Builder disableBorder()

Disable border, the log content won't be surrounded by a border.

Returns:

the builder

Since:

1.7.0

jsonFormatter

public Logger.Builder jsonFormatter(JsonFormatter jsonFormatter)

Set the JSON formatter when Logger log a JSON string.

Parameters:

jsonFormatter - the JSON formatter when Logger log a JSON string

Returns:

the builder

xmlFormatter

public Logger.Builder xmlFormatter(XmlFormatter xmlFormatter)

Set the XML formatter when Logger log a XML string.

Parameters:

xmlFormatter - the XML formatter when Logger log a XML string

Returns:

the builder

throwableFormatter

public Logger.Builder throwableFormatter(ThrowableFormatter throwableFormatter)

Set the throwable formatter when Logger log a message with throwable.

Parameters:

throwableFormatter - the throwable formatter when Logger log a message with throwable

Returns:

the builder

threadFormatter

public Logger.Builder threadFormatter(ThreadFormatter threadFormatter)

Set the thread formatter when Logger logging.

Parameters:

threadFormatter - the thread formatter when Logger logging

Returns:

the builder

stackTraceFormatter

public Logger.Builder stackTraceFormatter(StackTraceFormatter stackTraceFormatter)

Set the stack trace formatter when Logger logging.

Parameters:

stackTraceFormatter - the stace trace formatter when Logger logging

Returns:

the builder

borderFormatter

public Logger.Builder borderFormatter(BorderFormatter borderFormatter)

Set the border formatter when Logger logging.

Parameters:

borderFormatter - the border formatter when Logger logging

Returns:

the builder

addObjectFormatter

public <T> Logger.Builder addObjectFormatter(java.lang.Class<T> objectClass,
                                             ObjectFormatter<? super T> objectFormatter)

Add an object formatter for specific class of object when Logger log an object.

Type Parameters:

T - the type of object

Parameters:

objectClass - the class of object

objectFormatter - the object formatter to add

Returns:

the builder

Since:

1.1.0

addInterceptor

public Logger.Builder addInterceptor(Interceptor interceptor)

Add an interceptor when Logger logging.

Parameters:

interceptor - the intercept to add

Returns:

the builder

Since:

1.3.0

printers

public Logger.Builder printers(Printer... printers)

Set the printers used to print the log when Logger log.

Parameters:

printers - the printers used to print the log when Logger log

Returns:

the builder

v

public void v(java.lang.Object object)

Convenience of build() and Logger.v(Object).

Since:

1.1.0

v

public void v(java.lang.Object[] array)

Convenience of build() and Logger.v(Object[]).

Since:

1.4.0

v

public void v(java.lang.String format,
              java.lang.Object... args)

Convenience of build() and Logger.v(String, Object...).

v

public void v(java.lang.String msg)

Convenience of build() and Logger.v(String).

v

public void v(java.lang.String msg,
              java.lang.Throwable tr)

Convenience of build() and Logger.v(String, Throwable).

d

public void d(java.lang.Object object)

Convenience of build() and Logger.d(Object).

Since:

1.1.0

d

public void d(java.lang.Object[] array)

Convenience of build() and Logger.d(Object[]).

Since:

1.4.0

d

public void d(java.lang.String format,
              java.lang.Object... args)

Convenience of build() and Logger.d(String, Object...).

d

public void d(java.lang.String msg)

Convenience of build() and Logger.d(String).

d

public void d(java.lang.String msg,
              java.lang.Throwable tr)

Convenience of build() and Logger.d(String, Throwable).

i

public void i(java.lang.Object object)

Convenience of build() and Logger.i(Object).

Since:

1.1.0

i

public void i(java.lang.Object[] array)

Convenience of build() and Logger.i(Object[]).

Since:

1.4.0

i

public void i(java.lang.String format,
              java.lang.Object... args)

Convenience of build() and Logger.i(String, Object...).

i

public void i(java.lang.String msg)

Convenience of build() and Logger.i(String).

i

public void i(java.lang.String msg,
              java.lang.Throwable tr)

Convenience of build() and Logger.i(String, Throwable).

w

public void w(java.lang.Object object)

Convenience of build() and Logger.w(Object).

Since:

1.1.0

w

public void w(java.lang.Object[] array)

Convenience of build() and Logger.w(Object[]).

Since:

1.4.0

w

public void w(java.lang.String format,
              java.lang.Object... args)

Convenience of build() and Logger.w(String, Object...).

w

public void w(java.lang.String msg)

Convenience of build() and Logger.w(String).

w

public void w(java.lang.String msg,
              java.lang.Throwable tr)

Convenience of build() and Logger.w(String, Throwable).

e

public void e(java.lang.Object object)

Convenience of build() and Logger.e(Object).

Since:

1.1.0

e

public void e(java.lang.Object[] array)

Convenience of build() and Logger.e(Object[]).

Since:

1.4.0

e

public void e(java.lang.String format,
              java.lang.Object... args)

Convenience of build() and Logger.e(String, Object...).

e

public void e(java.lang.String msg)

Convenience of build() and Logger.e(String).

e

public void e(java.lang.String msg,
              java.lang.Throwable tr)

Convenience of build() and Logger.e(String, Throwable).

log

public void log(int logLevel,
                java.lang.Object object)

Convenience of build() and Logger.log(int, Object).

Since:

1.4.0

log

public void log(int logLevel,
                java.lang.Object[] array)

Convenience of build() and Logger.log(int, Object[]).

Since:

1.4.0

log

public void log(int logLevel,
                java.lang.String format,
                java.lang.Object... args)

Convenience of build() and Logger.log(int, String, Object...).

Since:

1.4.0

log

public void log(int logLevel,
                java.lang.String msg)

Convenience of build() and Logger.log(int, String).

Since:

1.4.0

log

public void log(int logLevel,
                java.lang.String msg,
                java.lang.Throwable tr)

Convenience of build() and Logger.log(int, String, Throwable).

Since:

1.4.0

json

public void json(java.lang.String json)

Convenience of build() and Logger.json(String).

xml

public void xml(java.lang.String xml)

Convenience of build() and Logger.xml(String).

build

public Logger build()

Builds configured Logger object.

Returns:

the built configured Logger object