LogConfiguration.Builder (xlog API)

java.lang.Object
- com.elvishew.xlog.LogConfiguration.Builder

Enclosing class:: LogConfiguration

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

Builder for LogConfiguration.

Constructor Summary

Constructors
Constructor and Description
`Builder()` Construct a builder with all default configurations.
`Builder(LogConfiguration logConfiguration)` Construct a builder with all configurations from another `LogConfiguration`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`LogConfiguration.Builder`	`addInterceptor(Interceptor interceptor)` Add an interceptor.
`<T> LogConfiguration.Builder`	`addObjectFormatter(java.lang.Class<T> objectClass, ObjectFormatter<? super T> objectFormatter)` Add a `ObjectFormatter` for specific class of object.
`LogConfiguration.Builder`	`b()` Deprecated. use `enableBorder()` instead, since 1.7.1
`LogConfiguration.Builder`	`borderFormatter(BorderFormatter borderFormatter)` Set the border formatter used when logging.
`LogConfiguration`	`build()` Builds configured `LogConfiguration` object.
`LogConfiguration.Builder`	`disableBorder()` Disable border, the log content won't be surrounded by a border.
`LogConfiguration.Builder`	`disableStackTrace()` Disable stack trace, the stack trace won't be printed with the log message.
`LogConfiguration.Builder`	`disableThreadInfo()` Disable thread info, the thread info won't be printed with the log message.
`LogConfiguration.Builder`	`enableBorder()` Enable border, the border would surround the entire log content, and separate the log message, thread info and stack trace.
`LogConfiguration.Builder`	`enableStackTrace(int depth)` Enable stack trace, the stack trace would be printed with the log message.
`LogConfiguration.Builder`	`enableStackTrace(java.lang.String stackTraceOrigin, int depth)` Enable stack trace, the stack trace would be printed with the log message.
`LogConfiguration.Builder`	`enableThreadInfo()` Enable thread info, the thread info would be printed with the log message.
`LogConfiguration.Builder`	`jsonFormatter(JsonFormatter jsonFormatter)` Set the JSON formatter used when log a JSON string.
`LogConfiguration.Builder`	`logLevel(int logLevel)` Set the log level, the logs below of which would not be printed.
`LogConfiguration.Builder`	`nb()` Deprecated. use `disableBorder()` instead, since 1.7.1
`LogConfiguration.Builder`	`nst()` Deprecated. use `disableStackTrace()` instead, since 1.7.1
`LogConfiguration.Builder`	`nt()` Deprecated. use `disableThreadInfo()` instead, since 1.7.1
`LogConfiguration.Builder`	`st(int depth)` Deprecated. use `enableStackTrace(int)` instead, since 1.7.1
`LogConfiguration.Builder`	`st(java.lang.String stackTraceOrigin, int depth)` Deprecated. use `enableStackTrace(String, int)` instead, since 1.7.1
`LogConfiguration.Builder`	`stackTraceFormatter(StackTraceFormatter stackTraceFormatter)` Set the stack trace formatter used when logging.
`LogConfiguration.Builder`	`t()` Deprecated. use `enableThreadInfo()` instead, since 1.7.1
`LogConfiguration.Builder`	`tag(java.lang.String tag)` Set the tag string used when log.
`LogConfiguration.Builder`	`threadFormatter(ThreadFormatter threadFormatter)` Set the thread formatter used when logging.
`LogConfiguration.Builder`	`throwableFormatter(ThrowableFormatter throwableFormatter)` Set the throwable formatter used when log a message with throwable.
`LogConfiguration.Builder`	`xmlFormatter(XmlFormatter xmlFormatter)` Set the XML formatter used when 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 with all default configurations.
  - Builder
```
public Builder(LogConfiguration logConfiguration)
```
    Construct a builder with all configurations from another LogConfiguration.
    
    Parameters:
    
    logConfiguration - the LogConfiguration to copy configurations from
- Method Detail
  - logLevel
```
public LogConfiguration.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 LogConfiguration.Builder tag(java.lang.String tag)
```
    Set the tag string used when log.
    
    Parameters:
    
    tag - the tag string used when log
    
    Returns:
    
    the builder
  - t
```
public LogConfiguration.Builder t()
```
    Deprecated. use enableThreadInfo() instead, since 1.7.1
    
    Enable thread info.
    
    Returns:
    
    the builder
  - enableThreadInfo
```
public LogConfiguration.Builder enableThreadInfo()
```
    Enable thread info, the thread info would be printed with the log message.
    
    Returns:
    
    the builder
    
    Since:
    
    1.7.1
    
    See Also:
    
    ThreadFormatter
  - nt
```
public LogConfiguration.Builder nt()
```
    Deprecated. use disableThreadInfo() instead, since 1.7.1
    
    Disable thread info.
    
    Returns:
    
    the builder
  - disableThreadInfo
```
public LogConfiguration.Builder disableThreadInfo()
```
    Disable thread info, the thread info won't be printed with the log message.
    
    Returns:
    
    the builder
    
    Since:
    
    1.7.1
  - st
```
public LogConfiguration.Builder st(int depth)
```
    Deprecated. use enableStackTrace(int) instead, since 1.7.1
    
    Enable stack trace.
    
    Parameters:
    
    depth - the number of stack trace elements we should log, 0 if no limitation
    
    Returns:
    
    the builder
  - enableStackTrace
```
public LogConfiguration.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.1
    
    See Also:
    
    StackTraceFormatter
  - st
```
public LogConfiguration.Builder st(java.lang.String stackTraceOrigin,
                                   int depth)
```
    Deprecated. use enableStackTrace(String, int) instead, since 1.7.1
    
    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 LogConfiguration.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.1
    
    See Also:
    
    StackTraceFormatter
  - nst
```
public LogConfiguration.Builder nst()
```
    Deprecated. use disableStackTrace() instead, since 1.7.1
    
    Disable stack trace.
    
    Returns:
    
    the builder
  - disableStackTrace
```
public LogConfiguration.Builder disableStackTrace()
```
    Disable stack trace, the stack trace won't be printed with the log message.
    
    Returns:
    
    the builder
    
    Since:
    
    1.7.1
    
    See Also:
    
    StackTraceFormatter
  - b
```
public LogConfiguration.Builder b()
```
    Deprecated. use enableBorder() instead, since 1.7.1
    
    Enable border.
    
    Returns:
    
    the builder
  - enableBorder
```
public LogConfiguration.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.1
    
    See Also:
    
    BorderFormatter
  - nb
```
public LogConfiguration.Builder nb()
```
    Deprecated. use disableBorder() instead, since 1.7.1
    
    Disable border.
    
    Returns:
    
    the builder
  - disableBorder
```
public LogConfiguration.Builder disableBorder()
```
    Disable border, the log content won't be surrounded by a border.
    
    Returns:
    
    the builder
    
    Since:
    
    1.7.1
  - jsonFormatter
```
public LogConfiguration.Builder jsonFormatter(JsonFormatter jsonFormatter)
```
    Set the JSON formatter used when log a JSON string.
    
    Parameters:
    
    jsonFormatter - the JSON formatter used when log a JSON string
    
    Returns:
    
    the builder
  - xmlFormatter
```
public LogConfiguration.Builder xmlFormatter(XmlFormatter xmlFormatter)
```
    Set the XML formatter used when log a XML string.
    
    Parameters:
    
    xmlFormatter - the XML formatter used when log a XML string
    
    Returns:
    
    the builder
  - throwableFormatter
```
public LogConfiguration.Builder throwableFormatter(ThrowableFormatter throwableFormatter)
```
    Set the throwable formatter used when log a message with throwable.
    
    Parameters:
    
    throwableFormatter - the throwable formatter used when log a message with throwable
    
    Returns:
    
    the builder
  - threadFormatter
```
public LogConfiguration.Builder threadFormatter(ThreadFormatter threadFormatter)
```
    Set the thread formatter used when logging.
    
    Parameters:
    
    threadFormatter - the thread formatter used when logging
    
    Returns:
    
    the builder
  - stackTraceFormatter
```
public LogConfiguration.Builder stackTraceFormatter(StackTraceFormatter stackTraceFormatter)
```
    Set the stack trace formatter used when logging.
    
    Parameters:
    
    stackTraceFormatter - the stack trace formatter used when logging
    
    Returns:
    
    the builder
  - borderFormatter
```
public LogConfiguration.Builder borderFormatter(BorderFormatter borderFormatter)
```
    Set the border formatter used when logging.
    
    Parameters:
    
    borderFormatter - the border formatter used when logging
    
    Returns:
    
    the builder
  - addObjectFormatter
```
public <T> LogConfiguration.Builder addObjectFormatter(java.lang.Class<T> objectClass,
                                                       ObjectFormatter<? super T> objectFormatter)
```
    Add a ObjectFormatter for specific class of 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 LogConfiguration.Builder addInterceptor(Interceptor interceptor)
```
    Add an interceptor.
    
    Parameters:
    
    interceptor - the interceptor to add
    
    Returns:
    
    the builder
    
    Since:
    
    1.3.0
  - build
```
public LogConfiguration build()
```
    Builds configured LogConfiguration object.
    
    Returns:
    
    the built configured LogConfiguration object

Class LogConfiguration.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

logLevel

tag

t

enableThreadInfo

nt

disableThreadInfo

st

enableStackTrace

st

enableStackTrace

nst

disableStackTrace

b

enableBorder

nb

disableBorder

jsonFormatter

xmlFormatter

throwableFormatter

threadFormatter

stackTraceFormatter

borderFormatter

addObjectFormatter

addInterceptor

build