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

Class RollingFileAppender.Builder<B extends RollingFileAppender.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.RollingFileAppender.Builder<B>

Type Parameters:

B - The type to build

All Implemented Interfaces:

Builder<RollingFileAppender>

Enclosing class:

RollingFileAppender

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

Builds FileAppender instances.

Since:

2.7

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	filePattern
private java.lang.String	filePermissions
private boolean	locking
private TriggeringPolicy	policy
private RolloverStrategy	strategy

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RollingFileAppender	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	getFilePattern()
java.lang.String	getFilePermissions()
TriggeringPolicy	getPolicy()
RolloverStrategy	getStrategy()
boolean	isAdvertise()
boolean	isAppend()
boolean	isCreateOnDemand()
boolean	isLocking()
B	setAdvertise(boolean advertise)
B	setAdvertiseUri(java.lang.String advertiseUri)
B	setAppend(boolean append)
B	setCreateOnDemand(boolean createOnDemand)
B	setFileGroup(java.lang.String fileGroup)
B	setFileName(java.lang.String fileName)
B	setFileOwner(java.lang.String fileOwner)
B	setFilePattern(java.lang.String filePattern)
B	setFilePermissions(java.lang.String filePermissions)
B	setLocking(boolean locking)
B	setPolicy(TriggeringPolicy policy)
B	setStrategy(RolloverStrategy strategy)
B	withAdvertise(boolean advertise)	Deprecated. since 2.26.0 use setAdvertise(boolean).
B	withAdvertiseUri(java.lang.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(java.lang.String fileGroup)	Deprecated. since 2.26.0 use setFileGroup(String).
B	withFileName(java.lang.String fileName)	Deprecated. since 2.26.0 use setFileName(String).
B	withFileOwner(java.lang.String fileOwner)	Deprecated. since 2.26.0 use setFileOwner(String).
B	withFilePattern(java.lang.String filePattern)	Deprecated. since 2.26.0 use setFilePattern(String).
B	withFilePermissions(java.lang.String filePermissions)	Deprecated. since 2.26.0 use setFilePermissions(String).
B	withLocking(boolean locking)	Deprecated. since 2.26.0 use setLocking(boolean).
B	withPolicy(TriggeringPolicy policy)	Deprecated. since 2.26.0 use setPolicy(TriggeringPolicy).
B	withStrategy(RolloverStrategy strategy)	Deprecated. since 2.26.0 use setStrategy(RolloverStrategy).

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
private java.lang.String fileName

filePattern

@PluginBuilderAttribute
@Required
private java.lang.String filePattern

append

@PluginBuilderAttribute
private boolean append

locking

@PluginBuilderAttribute
private boolean locking

policy

@PluginElement("Policy")
@Required
private TriggeringPolicy policy

strategy

@PluginElement("Strategy")
private RolloverStrategy strategy

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 RollingFileAppender 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 RollingFileAppender.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()

setAdvertise

public B setAdvertise(boolean advertise)

Since:

2.26.0

setAdvertiseUri

public B setAdvertiseUri(java.lang.String advertiseUri)

Since:

2.26.0

setAppend

public B setAppend(boolean append)

Since:

2.26.0

setFileName

public B setFileName(java.lang.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

withAdvertise

@Deprecated
public B withAdvertise(boolean advertise)

Deprecated.

since 2.26.0 use setAdvertise(boolean).

withAdvertiseUri

@Deprecated
public B withAdvertiseUri(java.lang.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(java.lang.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).

getFilePattern

public java.lang.String getFilePattern()

getPolicy

public TriggeringPolicy getPolicy()

getStrategy

public RolloverStrategy getStrategy()

setFilePattern

public B setFilePattern(java.lang.String filePattern)

Since:

2.26.0

setPolicy

public B setPolicy(TriggeringPolicy policy)

Since:

2.26.0

setStrategy

public B setStrategy(RolloverStrategy strategy)

Since:

2.26.0

setFilePermissions

public B setFilePermissions(java.lang.String filePermissions)

Since:

2.26.0

setFileOwner

public B setFileOwner(java.lang.String fileOwner)

Since:

2.26.0

setFileGroup

public B setFileGroup(java.lang.String fileGroup)

Since:

2.26.0

withFilePattern

@Deprecated
public B withFilePattern(java.lang.String filePattern)

Deprecated.

since 2.26.0 use setFilePattern(String).

withPolicy

@Deprecated
public B withPolicy(TriggeringPolicy policy)

Deprecated.

since 2.26.0 use setPolicy(TriggeringPolicy).

withStrategy

@Deprecated
public B withStrategy(RolloverStrategy strategy)

Deprecated.

since 2.26.0 use setStrategy(RolloverStrategy).

withFilePermissions

@Deprecated
public B withFilePermissions(java.lang.String filePermissions)

Deprecated.

since 2.26.0 use setFilePermissions(String).

withFileOwner

@Deprecated
public B withFileOwner(java.lang.String fileOwner)

Deprecated.

since 2.26.0 use setFileOwner(String).

withFileGroup

@Deprecated
public B withFileGroup(java.lang.String fileGroup)

Deprecated.

since 2.26.0 use setFileGroup(String).