org.mym.plog.config

Class PLogConfig.Builder

java.lang.Object

org.mym.plog.config.PLogConfig.Builder

Enclosing class:

PLogConfig

public static final class PLogConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder() Create a builder, you can also use static method PLogConfig.newBuilder().
Builder(PLogConfig copy) Create a builder.

Method Summary

Modifier and Type	Method and Description
PLogConfig	build()
PLogConfig.Builder	emptyMsg(String val) Set default message for log printed by calling PLog.empty().
PLogConfig.Builder	emptyMsgLevel(int val) Set level for empty log.
PLogConfig.Builder	forceConcatGlobalTag(boolean val) If set to true, all tags will be appended after global tag, regardless of it is an auto tag or explicit tag.
PLogConfig.Builder	globalInterceptor(Interceptor val) Register a global interceptor, useful for handle different app environments etc.
PLogConfig.Builder	globalStackOffset(int val) Set a global stack offset.
PLogConfig.Builder	globalTag(String val) Set global tag for all logs, param should not be null.
PLogConfig.Builder	keepLineNumber(boolean val) Deprecated. This method name is a little ambiguous, use needLineNumber(boolean) instead.
PLogConfig.Builder	keepThreadInfo(boolean val) Deprecated. This method name is a little ambiguous, use needThreadInfo(boolean) instead.
PLogConfig.Builder	maxRecursiveDepth(int depth) Set max depth limit when recursively format objects.
PLogConfig.Builder	needLineNumber(boolean val) If set to true, the source line number info will be printed in log message.
PLogConfig.Builder	needThreadInfo(boolean val) If set to true, thread info will be printed into log message.
PLogConfig.Builder	useAutoTag(boolean val) If set to true(as default option), use class name as tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Create a builder, you can also use static method PLogConfig.newBuilder().

Builder

public Builder(PLogConfig copy)

Create a builder.

Method Detail

globalTag

public PLogConfig.Builder globalTag(@NonNull
                                    String val)

Set global tag for all logs, param should not be null.

forceConcatGlobalTag

public PLogConfig.Builder forceConcatGlobalTag(boolean val)

If set to true, all tags will be appended after global tag, regardless of it is an auto tag or explicit tag. We recommend you set to true if you've set a `global tag`.

useAutoTag

public PLogConfig.Builder useAutoTag(boolean val)

If set to true(as default option), use class name as tag.

Since:

1.2.0

emptyMsgLevel

public PLogConfig.Builder emptyMsgLevel(int val)

Set level for empty log. Default is

Log.DEBUG

.

Parameters:

val - Must be one of Log.VERBOSE, Log.DEBUG, Log.INFO, Log.WARN, Log.ERROR. Otherwise this param is ignored.

emptyMsg

public PLogConfig.Builder emptyMsg(@NonNull
                                   String val)

Set default message for log printed by calling PLog.empty().

keepLineNumber

public PLogConfig.Builder keepLineNumber(boolean val)

Deprecated. This method name is a little ambiguous, use needLineNumber(boolean) instead.

If set to true, the line number info will be printed in log message.

needLineNumber

public PLogConfig.Builder needLineNumber(boolean val)

If set to true, the source line number info will be printed in log message.

globalStackOffset

public PLogConfig.Builder globalStackOffset(int val)

Set a global stack offset.

The recommended value is your wrapper level to `PLog` calls. If you use PLog.xxx() directly, you DO NOT need this method.

globalInterceptor

public PLogConfig.Builder globalInterceptor(@Nullable
                                            Interceptor val)

Register a global interceptor, useful for handle different app environments etc.

keepThreadInfo

@Deprecated
public PLogConfig.Builder keepThreadInfo(boolean val)

Deprecated. This method name is a little ambiguous, use needThreadInfo(boolean) instead.

needThreadInfo

public PLogConfig.Builder needThreadInfo(boolean val)

If set to true, thread info will be printed into log message.

maxRecursiveDepth

public PLogConfig.Builder maxRecursiveDepth(int depth)

Set max depth limit when recursively format objects. If you do not use `formatter` dependency, you don't need this option as well.

Parameters:

depth - should be positive. pass non-positive value will totally disable recursive formatting.

Since:

2.0.0

build

public PLogConfig build()