org.mym.plog.printer

Class FilePrinter

java.lang.Object

org.mym.plog.AbsPrinter

org.mym.plog.printer.FilePrinter

All Implemented Interfaces:

Closeable, AutoCloseable, Interceptor, Printer

public class FilePrinter
extends AbsPrinter
implements Closeable

Print logs into a file. Soft wrap is disabled by default.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FilePrinter.FileNameGenerator The interface to generate new log file.
static class	FilePrinter.TimingFileNameGenerator

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DIR_EXT_FILES Place holder string for the external files dir.
protected static String	DIR_EXT_ROOT Place holder string for the external storage root dir.(requires WRITE PERMISSION)
protected static String	DIR_INT_FILES Place holder string for the internal files dir.

Constructor Summary

Constructors

Constructor and Description
FilePrinter(Context context) Create a file printer using default path (external files dir).
FilePrinter(Context context, String logFilePath) Create a file printer using specified path.
FilePrinter(Context context, String filePath, FilePrinter.FileNameGenerator generator, long fileSizeLimit) Create a file printer.

Method Summary

Modifier and Type	Method and Description
void	close() Close associated files, etc.
protected String	createPrintText(int level, String tag, String msg) Override this method to redefine your preferred output format.
String	getLogFilePath() Get the absolute path for log files.
void	print(int level, String tag, String msg) Do the real output operation, e.g.
protected void	printFileHeader(PrintStreamPrinter printer) This method provides a quick method to provide file header, e.g.

Methods inherited from class org.mym.plog.AbsPrinter

getFormatter, getMaxLengthPerLine, getSoftWrapper, getStyle, onIntercept, setFormatter, setInterceptor, setSoftWrapper, setStyle

Methods inherited from class java.lang.Object

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

Field Detail

DIR_INT_FILES

protected static final String DIR_INT_FILES

Place holder string for the internal files dir.

See Also:

Context.getFilesDir(), Constant Field Values

DIR_EXT_FILES

protected static final String DIR_EXT_FILES

Place holder string for the external files dir. (requires no permission)

See Also:

Context.getExternalFilesDir(String), Constant Field Values

DIR_EXT_ROOT

protected static final String DIR_EXT_ROOT

Place holder string for the external storage root dir.(requires WRITE PERMISSION)

See Also:

Environment.getExternalStorageDirectory(), Constant Field Values

Constructor Detail

FilePrinter

public FilePrinter(@NonNull
                   Context context)
            throws IllegalStateException

Create a file printer using default path (external files dir).

Throws:

IllegalStateException - If try to use external storage but external storage is unavailable.

FilePrinter

public FilePrinter(@NonNull
                   Context context,
                   @NonNull
                   String logFilePath)
            throws IllegalStateException

Create a file printer using specified path.

Parameters:

logFilePath - absolute path; may use predefined placeholders in start. Currently supported placeholders: DIR_INT_FILES, DIR_EXT_FILES, DIR_EXT_ROOT.

Throws:

IllegalStateException - If try to use external storage but external storage is unavailable.

FilePrinter

public FilePrinter(@NonNull
                   Context context,
                   @NonNull
                   String filePath,
                   @NonNull
                   FilePrinter.FileNameGenerator generator,
                   long fileSizeLimit)
            throws IllegalStateException

Create a file printer.

Parameters:

fileSizeLimit - file size limit. By default a single log file would not over 1M. If a non-positive integer is provided, log files has no size limit.

generator - a generator to provide filename when creating new log file.

Throws:

IllegalStateException

Method Detail

print

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

Description copied from interface: Printer

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

Specified by:

print in interface Printer

Parameters:

level - print level of this log.

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

printFileHeader

protected void printFileHeader(PrintStreamPrinter printer)

This method provides a quick method to provide file header, e.g. crash files. Although you still need to extends this class, but you needn't copy whole file management code.

createPrintText

protected String createPrintText(int level,
                                 String tag,
                                 String msg)

Override this method to redefine your preferred output format. By default the log format is similar as shown in logcat.

Parameters:

level - log level

tag - log tag

msg - log content

Returns:

the text to be written to file

getLogFilePath

public final String getLogFilePath()

Get the absolute path for log files. The proposal of this method is to debug or traverse log path, not setting it.

Override this method is not really recommended; consider using constructor instead.

Returns:

the absolute path for log files; should not be null

close

public void close()

Close associated files, etc.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable