Package com.elvishew.xlog.printer.file

Class FilePrinter.Builder

java.lang.Object

com.elvishew.xlog.printer.file.FilePrinter.Builder

Enclosing class:

FilePrinter

public static class FilePrinter.Builder
extends java.lang.Object

Builder for FilePrinter.

Constructor Summary

Constructors

Constructor	Description
Builder(java.lang.String folderPath)	Construct a builder.

Method Summary

Modifier and Type	Method	Description
FilePrinter.Builder	backupStrategy(BackupStrategy backupStrategy)	Set the backup strategy for log file.
FilePrinter	build()	Build configured FilePrinter object.
FilePrinter.Builder	cleanStrategy(CleanStrategy cleanStrategy)	Set the clean strategy for log file.
FilePrinter.Builder	fileNameGenerator(FileNameGenerator fileNameGenerator)	Set the file name generator for log file.
FilePrinter.Builder	flattener(Flattener2 flattener)	Set the flattener when print a log.
FilePrinter.Builder	logFlattener(Flattener flattener)	Deprecated. Flattener is deprecated, use flattener(Flattener2) instead, since 1.6.0
FilePrinter.Builder	writer(Writer writer)	Set the writer to write log into log file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String folderPath)

Construct a builder.

Parameters:

folderPath - the folder path of log file

Method Detail

fileNameGenerator

public FilePrinter.Builder fileNameGenerator(FileNameGenerator fileNameGenerator)

Set the file name generator for log file.

Parameters:

fileNameGenerator - the file name generator for log file

Returns:

the builder

backupStrategy

public FilePrinter.Builder backupStrategy(BackupStrategy backupStrategy)

Set the backup strategy for log file.

Parameters:

backupStrategy - the backup strategy for log file

Returns:

the builder

cleanStrategy

public FilePrinter.Builder cleanStrategy(CleanStrategy cleanStrategy)

Set the clean strategy for log file.

Parameters:

cleanStrategy - the clean strategy for log file

Returns:

the builder

Since:

1.5.0

logFlattener

@Deprecated
public FilePrinter.Builder logFlattener(Flattener flattener)

Deprecated.

Flattener is deprecated, use flattener(Flattener2) instead, since 1.6.0

Set the flattener when print a log.

Parameters:

flattener - the flattener when print a log

Returns:

the builder

flattener

public FilePrinter.Builder flattener(Flattener2 flattener)

Set the flattener when print a log.

Parameters:

flattener - the flattener when print a log

Returns:

the builder

Since:

1.6.0

writer

public FilePrinter.Builder writer(Writer writer)

Set the writer to write log into log file.

Parameters:

writer - the writer to write log into log file

Returns:

the builder

Since:

1.11.0

build

public FilePrinter build()

Build configured FilePrinter object.

Returns:

the built configured FilePrinter object