AppenderBase

java.lang.Object
- ch.qos.logback.core.spi.ContextAwareBase
- - ch.qos.logback.core.AppenderBase<E>

All Implemented Interfaces:

Appender<E>, ContextAware, FilterAttachable<E>, LifeCycle

Direct Known Subclasses:

AbstractServerSocketAppender, AbstractSocketAppender, CyclicBufferAppender, JMSAppenderBase, ListAppender, NOPAppender, SiftingAppenderBase, SMTPAppenderBase, SyslogAppenderBase
```
public abstract class AppenderBase<E>
extends ContextAwareBase
implements Appender<E>
```
Sets a skeleton implementation for appenders.
For more information about this appender, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#AppenderBase

Field Summary

Fields

Modifier and Type	Field and Description
`protected String`	`name` Appenders are named.
`protected boolean`	`started`

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase
context

Constructor Summary

Constructors

Constructor and Description
`AppenderBase()`

Method Summary

All Methods

Instance Methods

Abstract Methods

Concrete Methods
Modifier and Type	Method and Description
`void`	`addFilter(Filter<E> newFilter)` Add a filter.
`protected abstract void`	`append(E eventObject)`
`void`	`clearAllFilters()`
`void`	`doAppend(E eventObject)` This is where an appender accomplishes its work.
`List<Filter<E>>`	`getCopyOfAttachedFiltersList()` Get a copy of all the filters contained within this FilterAttachable object.
`FilterReply`	`getFilterChainDecision(E event)` Loop through the filters in the chain.
`String`	`getName()` Get the name of this appender.
`boolean`	`isStarted()`
`void`	`setName(String name)` Set the name of this appender.
`void`	`start()`
`void`	`stop()`
`String`	`toString()`

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.qos.logback.core.spi.ContextAware
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

- Field Detail
  - started
```
protected volatile boolean started
```
  - name
```
protected String name
```
    Appenders are named.
- Constructor Detail
  - AppenderBase
```
public AppenderBase()
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: Appender
    
    Get the name of this appender. The name uniquely identifies the appender.
  - doAppend
```
public void doAppend(E eventObject)
```
    Description copied from interface: Appender
    
    This is where an appender accomplishes its work. Note that the argument is of type Object.
  - append
```
protected abstract void append(E eventObject)
```
  - setName
```
public void setName(String name)
```
    Set the name of this appender.
  - start
```
public void start()
```
  - stop
```
public void stop()
```
  - isStarted
```
public boolean isStarted()
```
  - toString
```
public String toString()
```
  - addFilter
```
public void addFilter(Filter<E> newFilter)
```
    Description copied from interface: FilterAttachable
    
    Add a filter.
  - clearAllFilters
```
public void clearAllFilters()
```
  - getCopyOfAttachedFiltersList
```
public List<Filter<E>> getCopyOfAttachedFiltersList()
```
    Description copied from interface: FilterAttachable
    
    Get a copy of all the filters contained within this FilterAttachable object.
    
    Specified by:
    
    getCopyOfAttachedFiltersList in interface FilterAttachable<E>
    
    Returns:
    
    all attached filters as a list
  - getFilterChainDecision
```
public FilterReply getFilterChainDecision(E event)
```
    Description copied from interface: FilterAttachable
    
    Loop through the filters in the chain. As soon as a filter decides on ACCEPT or DENY, then that value is returned. If all of the filters return NEUTRAL, then NEUTRAL is returned.

Class AppenderBase<E>

Field Summary

Fields

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

Constructor Summary

Constructors

Method Summary

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

Methods inherited from class java.lang.Object

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

Field Detail

started

name

Constructor Detail

AppenderBase

Method Detail

getName

doAppend

append

setName

start

stop

isStarted

toString

addFilter

clearAllFilters

getCopyOfAttachedFiltersList

getFilterChainDecision