org.mym.plog

Interface Printer

All Superinterfaces:

Interceptor

All Known Implementing Classes:

AbsPrinter, DebugPrinter, FilePrinter

public interface Printer
extends Interceptor

This interface and its subclasses define the onIntercept and output rules. Please consider it as compose of logger and controller in PLog 1.x version; or just like the "Tree" concept of Timber library.

Since:

2.0.0

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()
void	print(int level, String tag, String msg) Do the real output operation, e.g.

Methods inherited from interface org.mym.plog.Interceptor

onIntercept

Method Detail

getFormatter

@Nullable
Formatter getFormatter()

Specify the formatter of this printer.

Returns:

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

getStyle

@Nullable
Style getStyle()

getSoftWrapper

SoftWrapper getSoftWrapper()

Specify word wrapper, if needed.

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

getMaxLengthPerLine

int getMaxLengthPerLine()

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

Returns:

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

print

void print(int level,
           @NonNull
           String tag,
           @NonNull
           String msg)

Do the real output operation, e.g. call Log.x(), or write to file.

Parameters:

level - print level of this log.

msg - content of this log(already formatted and soft wrapped, if needed).