Logger.Builder (library API)

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.

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

Method Summary

All Methods Instance Methods Concrete Methods
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()` Enable border.
`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)`.
`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)`.
`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()` Disable border.
`Logger.Builder`	`nst()` Disable stack trace.
`Logger.Builder`	`nt()` Disable thread info.
`Logger.Builder`	`printers(Printer... printers)` Set the printers used to print the log when `Logger` log.
`Logger.Builder`	`st(int depth)` Enable stack trace.
`Logger.Builder`	`st(java.lang.String stackTraceOrigin, int depth)` Enable stack trace.
`Logger.Builder`	`stackTraceFormatter(StackTraceFormatter stackTraceFormatter)` Set the stack trace formatter when `Logger` logging.
`Logger.Builder`	`t()` Enable thread info.
`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
```
public Logger.Builder t()
```
    Enable thread info.
    
    Returns:
    
    the builder
  - nt
```
public Logger.Builder nt()
```
    Disable thread info.
    
    Returns:
    
    the builder
  - st
```
public Logger.Builder st(int depth)
```
    Enable stack trace.
    
    Parameters:
    
    depth - the number of stack trace elements we should log, 0 if no limitation
    
    Returns:
    
    the builder
  - st
```
public Logger.Builder st(java.lang.String stackTraceOrigin,
                         int depth)
```
    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
  - nst
```
public Logger.Builder nst()
```
    Disable stack trace.
    
    Returns:
    
    the builder
  - b
```
public Logger.Builder b()
```
    Enable border.
    
    Returns:
    
    the builder
  - nb
```
public Logger.Builder nb()
```
    Disable border.
    
    Returns:
    
    the builder
  - 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

Class Logger.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

logLevel

tag

t

nt

st

st

nst

b

nb

jsonFormatter

xmlFormatter

throwableFormatter

threadFormatter

stackTraceFormatter

borderFormatter

addObjectFormatter

addInterceptor

printers

v

v

v

v

v

d

d

d

d

d

i

i

i

i

i

w

w

w

w

w

e

e

e

e

e

log

log

log

log

log

json

xml

build