org.mym.plog

Class AbsPrinter

java.lang.Object

org.mym.plog.AbsPrinter

All Implemented Interfaces:

Interceptor, Printer

Direct Known Subclasses:

DebugPrinter, FilePrinter

public abstract class AbsPrinter
extends Object
implements Printer

An abstract implementation for printer，Only default initialization and get/set methods are implemented.

Since:

2.0.0-beta2

Constructor Summary

Constructors

Constructor and Description
AbsPrinter()
AbsPrinter(int maxLengthPerLine)

Method Summary

Modifier and Type	Method and Description
Formatter	getFormatter() Specify the formatter of this printer.
int	getMaxLengthPerLine() Indicate how many characters should contains in one line; but only affect when soft wrap is enabled.
SoftWrapper	getSoftWrapper() Specify word wrapper, if needed.
Style	getStyle()
boolean	onIntercept(int level, String tag, Category category, String msg) Decide whether this item of log should be intercepted.
void	setFormatter(Formatter formatter)
void	setInterceptor(Interceptor interceptor)
void	setSoftWrapper(SoftWrapper softWrapper)
void	setStyle(Style style)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mym.plog.Printer

print

Constructor Detail

AbsPrinter

public AbsPrinter()

AbsPrinter

public AbsPrinter(int maxLengthPerLine)

Method Detail

getFormatter

@Nullable
public Formatter getFormatter()

Description copied from interface: Printer

Specify the formatter of this printer.

Specified by:

getFormatter in interface Printer

Returns:

can be null. If so, msg would never be formatted.

setFormatter

public void setFormatter(Formatter formatter)

getSoftWrapper

public SoftWrapper getSoftWrapper()

Description copied from interface: Printer

Specify word wrapper, if needed.

Specified by:

getSoftWrapper in interface Printer

Returns:

the soft wrapper implementation; return null means disable soft wrap for this printer. The constant implementation defined in SoftWrapper is strongly recommended.

See Also:

SoftWrapper.WORD_BREAK_WRAPPER, SoftWrapper.WORD_LENGTH_WRAPPER

setSoftWrapper

public void setSoftWrapper(SoftWrapper softWrapper)

getStyle

@Nullable
public Style getStyle()

Specified by:

getStyle in interface Printer

setStyle

public void setStyle(Style style)

getMaxLengthPerLine

public int getMaxLengthPerLine()

Description copied from interface: Printer

Indicate how many characters should contains in one line; but only affect when soft wrap is enabled. That is, Printer.getSoftWrapper() returns not null.

Specified by:

getMaxLengthPerLine in interface Printer

Returns:

Should be a positive integer; otherwise you will get an argument exception.

onIntercept

public boolean onIntercept(int level,
                           @NonNull
                           String tag,
                           @Nullable
                           Category category,
                           @NonNull
                           String msg)

Description copied from interface: Interceptor

Decide whether this item of log should be intercepted.

Specified by:

onIntercept in interface Interceptor

Parameters:

level - print level of this log.

category - category of this log, if specified.

msg - content of this log(before formatting!). Note if msg in the original request is null, you'll get an empty string here.

Returns:

if returns true, this log won't be printed and just be ignored. Otherwise it would be formatted and printed as usual.

setInterceptor

public void setInterceptor(Interceptor interceptor)