Class AsyncAppender.Builder<B extends AsyncAppender.Builder<B>>

java.lang.Object

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

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

All Implemented Interfaces:

Builder<AsyncAppender>

Enclosing class:

AsyncAppender

public static class AsyncAppender.Builder<B extends AsyncAppender.Builder<B>>
extends AbstractFilterable.Builder<B>
implements Builder<AsyncAppender>

Field Summary

Fields

Modifier and Type	Field	Description
private AppenderRef[]	appenderRefs
private boolean	blocking
private BlockingQueueFactory<LogEvent>	blockingQueueFactory
private int	bufferSize
private Configuration	configuration
private String	errorRef
private boolean	ignoreExceptions
private boolean	includeLocation
private String	name
private long	shutdownTimeout

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AsyncAppender	build()	Builds the object after all configuration has been set.
AsyncAppender.Builder	setAppenderRefs(AppenderRef[] appenderRefs)
AsyncAppender.Builder	setBlocking(boolean blocking)
AsyncAppender.Builder	setBlockingQueueFactory(BlockingQueueFactory<LogEvent> blockingQueueFactory)
AsyncAppender.Builder	setBufferSize(int bufferSize)
AsyncAppender.Builder	setConfiguration(Configuration configuration)
AsyncAppender.Builder	setErrorRef(String errorRef)
AsyncAppender.Builder	setIgnoreExceptions(boolean ignoreExceptions)
AsyncAppender.Builder	setIncludeLocation(boolean includeLocation)
AsyncAppender.Builder	setName(String name)
AsyncAppender.Builder	setShutdownTimeout(long shutdownTimeout)

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

appenderRefs

@PluginElement("AppenderRef")
@Required(message="No appender references provided to AsyncAppender")
private AppenderRef[] appenderRefs

errorRef

@PluginBuilderAttribute
@PluginAliases("error-ref")
private String errorRef

blocking

@PluginBuilderAttribute
private boolean blocking

shutdownTimeout

@PluginBuilderAttribute
private long shutdownTimeout

bufferSize

@PluginBuilderAttribute
private int bufferSize

name

@PluginBuilderAttribute
@Required(message="No name provided for AsyncAppender")
private String name

includeLocation

@PluginBuilderAttribute
private boolean includeLocation

configuration

@PluginConfiguration
private Configuration configuration

ignoreExceptions

@PluginBuilderAttribute
private boolean ignoreExceptions

blockingQueueFactory

@PluginElement("BlockingQueueFactory")
private BlockingQueueFactory<LogEvent> blockingQueueFactory

Constructor Details

Builder

public Builder()

Method Details

setAppenderRefs

public AsyncAppender.Builder setAppenderRefs(AppenderRef[] appenderRefs)

setErrorRef

public AsyncAppender.Builder setErrorRef(String errorRef)

setBlocking

public AsyncAppender.Builder setBlocking(boolean blocking)

setShutdownTimeout

public AsyncAppender.Builder setShutdownTimeout(long shutdownTimeout)

setBufferSize

public AsyncAppender.Builder setBufferSize(int bufferSize)

setName

public AsyncAppender.Builder setName(String name)

setIncludeLocation

public AsyncAppender.Builder setIncludeLocation(boolean includeLocation)

setConfiguration

public AsyncAppender.Builder setConfiguration(Configuration configuration)

setIgnoreExceptions

public AsyncAppender.Builder setIgnoreExceptions(boolean ignoreExceptions)

setBlockingQueueFactory

public AsyncAppender.Builder setBlockingQueueFactory(BlockingQueueFactory<LogEvent> blockingQueueFactory)

build

public AsyncAppender 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 AsyncAppender.Builder<B>>

Returns:

the configured instance.