Package org.apache.logging.log4j.core.appender

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 java.lang.String	advertiseUri
private boolean	append
private boolean	createOnDemand
private java.lang.String	fileGroup
private java.lang.String	fileName
private java.lang.String	fileOwner
private java.lang.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.
java.lang.String	getAdvertiseUri()
java.lang.String	getFileGroup()
java.lang.String	getFileName()
java.lang.String	getFileOwner()
java.lang.String	getFilePermissions()
boolean	isAdvertise()
boolean	isAppend()
boolean	isCreateOnDemand()
boolean	isLocking()
B	withAdvertise(boolean advertise)
B	withAdvertiseUri(java.lang.String advertiseUri)
B	withAppend(boolean append)
B	withCreateOnDemand(boolean createOnDemand)
B	withFileGroup(java.lang.String fileGroup)
B	withFileName(java.lang.String fileName)
B	withFileOwner(java.lang.String fileOwner)
B	withFilePermissions(java.lang.String filePermissions)
B	withLocking(boolean locking)

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder

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

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender.Builder

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

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable.Builder

asBuilder, getFilter, getPropertyArray, setFilter, setPropertyArray, withFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

fileName

@PluginBuilderAttribute
@Required
private java.lang.String fileName

append

@PluginBuilderAttribute
private boolean append

locking

@PluginBuilderAttribute
private boolean locking

advertise

@PluginBuilderAttribute
private boolean advertise

advertiseUri

@PluginBuilderAttribute
private java.lang.String advertiseUri

createOnDemand

@PluginBuilderAttribute
private boolean createOnDemand

filePermissions

@PluginBuilderAttribute
private java.lang.String filePermissions

fileOwner

@PluginBuilderAttribute
private java.lang.String fileOwner

fileGroup

@PluginBuilderAttribute
private java.lang.String fileGroup

Constructor Detail

Builder

public Builder()

Method Detail

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 java.lang.String getAdvertiseUri()

getFileName

public java.lang.String getFileName()

isAdvertise

public boolean isAdvertise()

isAppend

public boolean isAppend()

isCreateOnDemand

public boolean isCreateOnDemand()

isLocking

public boolean isLocking()

getFilePermissions

public java.lang.String getFilePermissions()

getFileOwner

public java.lang.String getFileOwner()

getFileGroup

public java.lang.String getFileGroup()

withAdvertise

public B withAdvertise(boolean advertise)

withAdvertiseUri

public B withAdvertiseUri(java.lang.String advertiseUri)

withAppend

public B withAppend(boolean append)

withFileName

public B withFileName(java.lang.String fileName)

withCreateOnDemand

public B withCreateOnDemand(boolean createOnDemand)

withLocking

public B withLocking(boolean locking)

withFilePermissions

public B withFilePermissions(java.lang.String filePermissions)

withFileOwner

public B withFileOwner(java.lang.String fileOwner)

withFileGroup

public B withFileGroup(java.lang.String fileGroup)