org.mym.plog.config

Class PLogConfig

java.lang.Object

org.mym.plog.config.PLogConfig

public class PLogConfig
extends Object

Configuration class for the whole library.

You can't call constructor directly; instead we recommend you to use Builder. All options are documented in that class.

Since:

1.0.0

See Also:

PLogConfig.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PLogConfig.Builder

Method Summary

Modifier and Type	Method and Description
static void	checkConfigSafe(PLogConfig config) Check whether a config is valid or not.
String	getEmptyMsg()
int	getEmptyMsgLevel()
Interceptor	getGlobalInterceptor()
int	getGlobalStackOffset()
String	getGlobalTag()
int	getMaxRecursiveDepth()
boolean	isForceConcatGlobalTag()
boolean	isNeedLineNumber()
boolean	isNeedThreadInfo()
boolean	isUseAutoTag()
static PLogConfig.Builder	newBuilder() Create a new Builder.
static PLogConfig.Builder	newBuilder(PLogConfig copy) Create a new builder and clone all options in the argument.

Methods inherited from class java.lang.Object

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

Method Detail

checkConfigSafe

public static void checkConfigSafe(PLogConfig config)
                            throws RuntimeException

Check whether a config is valid or not. This is useful when our library importing new config items, and can prevent user's wrong usage.

If all condition check pass, then this method do nothing; otherwise it would throw a Runtime Exception.

Parameters:

config - config object to detect

Throws:

RuntimeException - maybe any subclass of RuntimeException if any assertion failed.

newBuilder

public static PLogConfig.Builder newBuilder()

Create a new Builder.

newBuilder

public static PLogConfig.Builder newBuilder(PLogConfig copy)

Create a new builder and clone all options in the argument.

getGlobalStackOffset

public int getGlobalStackOffset()

getEmptyMsg

public String getEmptyMsg()

getEmptyMsgLevel

public int getEmptyMsgLevel()

getGlobalTag

public String getGlobalTag()

isForceConcatGlobalTag

public boolean isForceConcatGlobalTag()

isUseAutoTag

public boolean isUseAutoTag()

getGlobalInterceptor

@Nullable
public Interceptor getGlobalInterceptor()

isNeedLineNumber

public boolean isNeedLineNumber()

isNeedThreadInfo

public boolean isNeedThreadInfo()

getMaxRecursiveDepth

public int getMaxRecursiveDepth()