Class FileAppender.Builder<B extends FileAppender.Builder<B>>

java.lang.Object

org.apache.logging.log4j.core.filter.AbstractFilterable.Builder<B>

org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B>

org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder<B>

org.apache.logging.log4j.core.appender.FileAppender.Builder<B>

Type Parameters:

B - The type to build

All Implemented Interfaces:

Builder<FileAppender>

Enclosing class:

FileAppender

public static class FileAppender.Builder<B extends FileAppender.Builder<B>>
extends AbstractOutputStreamAppender.Builder<B>
implements Builder<FileAppender>

Builds FileAppender instances.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	advertise
private String	advertiseUri
private boolean	append
private boolean	createOnDemand
private String	fileGroup
private String	fileName
private String	fileOwner
private String	filePermissions
private boolean	locking

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FileAppender	build()	Builds the object after all configuration has been set.
String	getAdvertiseUri()
String	getFileGroup()
String	getFileName()
String	getFileOwner()
String	getFilePermissions()
boolean	isAdvertise()
boolean	isAppend()
boolean	isCreateOnDemand()
boolean	isLocking()
B	setAdvertise(boolean advertise)
B	setAdvertiseUri(String advertiseUri)
B	setAppend(boolean append)
B	setCreateOnDemand(boolean createOnDemand)
B	setFileGroup(String fileGroup)
B	setFileName(String fileName)
B	setFileOwner(String fileOwner)
B	setFilePermissions(String filePermissions)
B	setLocking(boolean locking)
B	withAdvertise(boolean advertise)	Deprecated. since 2.26.0 use setAdvertise(boolean).
B	withAdvertiseUri(String advertiseUri)	Deprecated. since 2.26.0 use setAdvertiseUri(String).
B	withAppend(boolean append)	Deprecated. since 2.26.0 use setAppend(boolean).
B	withCreateOnDemand(boolean createOnDemand)	Deprecated. since 2.26.0 use setCreateOnDemand(boolean).
B	withFileGroup(String fileGroup)	Deprecated. since 2.26.0 use setFileGroup(String).
B	withFileName(String fileName)	Deprecated. since 2.26.0 use setFileName(String).
B	withFileOwner(String fileOwner)	Deprecated. since 2.26.0 use setFileOwner(String).
B	withFilePermissions(String filePermissions)	Deprecated. since 2.26.0 use setFilePermissions(String).
B	withLocking(boolean locking)	Deprecated. since 2.26.0 use setLocking(boolean).

Methods inherited from class AbstractOutputStreamAppender.Builder

getBufferSize, isBufferedIo, isImmediateFlush, setBufferedIo, setBufferSize, setImmediateFlush, withBufferedIo, withBufferSize, withImmediateFlush

Methods inherited from class AbstractAppender.Builder

getConfiguration, getErrorPrefix, getLayout, getName, getOrCreateLayout, getOrCreateLayout, isIgnoreExceptions, setConfiguration, setIgnoreExceptions, setLayout, setName, withConfiguration, withIgnoreExceptions, withLayout, withName

Methods inherited from class AbstractFilterable.Builder

asBuilder, getFilter, getPropertyArray, setFilter, setPropertyArray, withFilter

Methods inherited from class Object

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

Methods inherited from interface Builder

getErrorPrefix, isValid

Field Details

fileName

@PluginBuilderAttribute
@Required
private String fileName

append

@PluginBuilderAttribute
private boolean append

locking

@PluginBuilderAttribute
private boolean locking

advertise

@PluginBuilderAttribute
private boolean advertise

advertiseUri

@PluginBuilderAttribute
private String advertiseUri

createOnDemand

@PluginBuilderAttribute
private boolean createOnDemand

filePermissions

@PluginBuilderAttribute
private String filePermissions

fileOwner

@PluginBuilderAttribute
private String fileOwner

fileGroup

@PluginBuilderAttribute
private String fileGroup

Constructor Details

Builder

public Builder()

Method Details

build

public FileAppender build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<B extends FileAppender.Builder<B>>

Returns:

the configured instance.

getAdvertiseUri

public String getAdvertiseUri()

getFileName

public String getFileName()

isAdvertise

public boolean isAdvertise()

isAppend

public boolean isAppend()

isCreateOnDemand

public boolean isCreateOnDemand()

isLocking

public boolean isLocking()

getFilePermissions

public String getFilePermissions()

getFileOwner

public String getFileOwner()

getFileGroup

public String getFileGroup()

setAdvertise

public B setAdvertise(boolean advertise)

Since:

2.26.0

setAdvertiseUri

public B setAdvertiseUri(String advertiseUri)

Since:

2.26.0

setAppend

public B setAppend(boolean append)

Since:

2.26.0

setFileName

public B setFileName(String fileName)

Since:

2.26.0

setCreateOnDemand

public B setCreateOnDemand(boolean createOnDemand)

Since:

2.26.0

setLocking

public B setLocking(boolean locking)

Since:

2.26.0

setFilePermissions

public B setFilePermissions(String filePermissions)

Since:

2.26.0

setFileOwner

public B setFileOwner(String fileOwner)

Since:

2.26.0

setFileGroup

public B setFileGroup(String fileGroup)

Since:

2.26.0

withAdvertise

@Deprecated
public B withAdvertise(boolean advertise)

Deprecated.

since 2.26.0 use setAdvertise(boolean).

withAdvertiseUri

@Deprecated
public B withAdvertiseUri(String advertiseUri)

Deprecated.

since 2.26.0 use setAdvertiseUri(String).

withAppend

@Deprecated
public B withAppend(boolean append)

Deprecated.

since 2.26.0 use setAppend(boolean).

withFileName

@Deprecated
public B withFileName(String fileName)

Deprecated.

since 2.26.0 use setFileName(String).

withCreateOnDemand

@Deprecated
public B withCreateOnDemand(boolean createOnDemand)

Deprecated.

since 2.26.0 use setCreateOnDemand(boolean).

withLocking

@Deprecated
public B withLocking(boolean locking)

Deprecated.

since 2.26.0 use setLocking(boolean).

withFilePermissions

@Deprecated
public B withFilePermissions(String filePermissions)

Deprecated.

since 2.26.0 use setFilePermissions(String).

withFileOwner

@Deprecated
public B withFileOwner(String fileOwner)

Deprecated.

since 2.26.0 use setFileOwner(String).

withFileGroup

@Deprecated
public B withFileGroup(String fileGroup)

Deprecated.

since 2.26.0 use setFileGroup(String).