org.apache.logging.log4j.core.config.builder.api

Interface AppenderComponentBuilder

All Superinterfaces:

Builder<Component>, ComponentBuilder<AppenderComponentBuilder>, FilterableComponentBuilder<AppenderComponentBuilder>

public interface AppenderComponentBuilder
extends FilterableComponentBuilder<AppenderComponentBuilder>

Builder for constructing Appender Components.

Since:

2.4

Method Summary

Modifier and Type	Method and Description
AppenderComponentBuilder	add(LayoutComponentBuilder builder) Adds a Layout to the Appender component.
String	getName() Returns the name of the Appender.

Methods inherited from interface org.apache.logging.log4j.core.config.builder.api.FilterableComponentBuilder

add

Methods inherited from interface org.apache.logging.log4j.core.config.builder.api.ComponentBuilder

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addComponent, getBuilder

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

build, getErrorPrefix, isValid

Method Detail

add

AppenderComponentBuilder add(LayoutComponentBuilder builder)

Adds a Layout to the Appender component.

Parameters:

builder - The LayoutComponentBuilder with all of its attributes set.

Returns:

this builder.

getName

String getName()

Returns the name of the Appender.

Specified by:

getName in interface ComponentBuilder<AppenderComponentBuilder>

Returns:

the name of the Appender.