org.apache.logging.log4j.core.config
Class LoggerConfig

java.lang.Object
  extended by org.apache.logging.log4j.core.filter.Filterable
      extended by org.apache.logging.log4j.core.config.LoggerConfig
All Implemented Interfaces:
Filtering, LogEventFactory
Direct Known Subclasses:
LoggerConfig.RootLogger

public class LoggerConfig
extends Filterable
implements LogEventFactory

Logger object that is created via configuration.


Nested Class Summary
static class LoggerConfig.RootLogger
          The root Logger.
 
Constructor Summary
  LoggerConfig()
          Default constructor.
  LoggerConfig(String name, Level level, boolean additive)
          Constructor that sets the name, level and additive values.
protected LoggerConfig(String name, List<AppenderRef> appenders, Filter filter, Level level, boolean additive)
           
 
Method Summary
 void addAppender(Appender appender, Level level, Filter filter)
          Add an Appender to the LoggerConfig.
protected  void clearAppenders()
          Remove all Appenders.
 LogEvent createEvent(String loggerName, Marker marker, String fqcn, Level level, Message data, Throwable t)
          Create a log event.
static LoggerConfig createLogger(String additivity, String loggerLevel, String loggerName, AppenderRef[] refs, Filter filter)
          Factory method to create a LoggerConfig.
 List<AppenderRef> getAppenderRefs()
          Return the Appender references.
 Map<String,Appender> getAppenders()
          Return all Appenders as a Map.
 Filter getFilter()
          Return the Filter.
 Level getLevel()
          Return the logging Level.
 LogEventFactory getLogEventFactory()
          Return the LogEventFactory.
 String getName()
          Return the name of the LoggerConfig.
 LoggerConfig getParent()
          Return the parent of this LoggerConfig.
 boolean isAdditive()
          Return the valid of the additive flag.
 void log(LogEvent event)
          Logs an event.
 void log(String loggerName, Marker marker, String fqcn, Level level, Message data, Throwable t)
          Log an event.
 void removeAppender(String name)
          Remove the Appender with the specific name.
 void setAdditive(boolean additive)
          Set the additive setting.
 void setConfigurationMonitor(ConfigurationMonitor monitor)
          Set the ConfigurationMonitor that will detect configuration changes.
 void setLevel(Level level)
          Set the logging Level.
 void setLogEventFactory(LogEventFactory logEventFactory)
          Set the LogEventFactory.
 void setParent(LoggerConfig parent)
          Set the parent of this LoggerConfig.
 String toString()
           
 
Methods inherited from class org.apache.logging.log4j.core.filter.Filterable
addFilter, hasFilter, isFiltered, removeFilter, startFilter, stopFilter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LoggerConfig

public LoggerConfig()
Default constructor.


LoggerConfig

public LoggerConfig(String name,
                    Level level,
                    boolean additive)
Constructor that sets the name, level and additive values.

Parameters:
name - The Logger name.
level - The Level.
additive - true if the Logger is additive, false otherwise.

LoggerConfig

protected LoggerConfig(String name,
                       List<AppenderRef> appenders,
                       Filter filter,
                       Level level,
                       boolean additive)
Method Detail

getFilter

public Filter getFilter()
Description copied from class: Filterable
Return the Filter.

Specified by:
getFilter in interface Filtering
Overrides:
getFilter in class Filterable
Returns:
the Filter.

setConfigurationMonitor

public void setConfigurationMonitor(ConfigurationMonitor monitor)
Set the ConfigurationMonitor that will detect configuration changes.

Parameters:
monitor - The ConfigurationMonitor.

getName

public String getName()
Return the name of the LoggerConfig.

Returns:
the name of the LoggerConfig.

setParent

public void setParent(LoggerConfig parent)
Set the parent of this LoggerConfig.

Parameters:
parent - the parent LoggerConfig.

getParent

public LoggerConfig getParent()
Return the parent of this LoggerConfig.

Returns:
the LoggerConfig that is the parent of this one.

addAppender

public void addAppender(Appender appender,
                        Level level,
                        Filter filter)
Add an Appender to the LoggerConfig.

Parameters:
appender - The Appender to add.
level - The Level to use.
filter - A Filter for the Appender reference.

removeAppender

public void removeAppender(String name)
Remove the Appender with the specific name.

Parameters:
name - The name of the Appender.

getAppenders

public Map<String,Appender> getAppenders()
Return all Appenders as a Map.

Returns:
a Map with the Appender name as the key and the Appender as the value.

clearAppenders

protected void clearAppenders()
Remove all Appenders.


getAppenderRefs

public List<AppenderRef> getAppenderRefs()
Return the Appender references.

Returns:
a List of all the Appender names attached to this LoggerConfig.

setLevel

public void setLevel(Level level)
Set the logging Level.

Parameters:
level - The logging Level.

getLevel

public Level getLevel()
Return the logging Level.

Returns:
the logging Level.

getLogEventFactory

public LogEventFactory getLogEventFactory()
Return the LogEventFactory.

Returns:
the LogEventFactory.

setLogEventFactory

public void setLogEventFactory(LogEventFactory logEventFactory)
Set the LogEventFactory. Usually the LogEventFactory will be this LoggerConfig.

Parameters:
logEventFactory - the LogEventFactory.

isAdditive

public boolean isAdditive()
Return the valid of the additive flag.

Returns:
true if the LoggerConfig is additive, false otherwise.

setAdditive

public void setAdditive(boolean additive)
Set the additive setting.

Parameters:
additive - true if thee LoggerConfig should be additive, false otherwise.

log

public void log(String loggerName,
                Marker marker,
                String fqcn,
                Level level,
                Message data,
                Throwable t)
Log an event.

Parameters:
loggerName - The name of the Logger.
marker - A Marker or null if none is present.
fqcn - The fully qualified class name of the caller.
level - The event Level.
data - The Message.
t - A Throwable or null.

log

public void log(LogEvent event)
Logs an event.

Parameters:
event - Yhe log event.

createEvent

public LogEvent createEvent(String loggerName,
                            Marker marker,
                            String fqcn,
                            Level level,
                            Message data,
                            Throwable t)
Create a log event.

Specified by:
createEvent in interface LogEventFactory
Parameters:
loggerName - The name of the Logger.
marker - An optional Marker.
fqcn - The fully qualified class name of the caller.
level - The event Level.
data - The Message.
t - An optional Throwable.
Returns:
The LogEvent.

toString

public String toString()
Overrides:
toString in class Object

createLogger

public static LoggerConfig createLogger(String additivity,
                                        String loggerLevel,
                                        String loggerName,
                                        AppenderRef[] refs,
                                        Filter filter)
Factory method to create a LoggerConfig.

Parameters:
additivity - True if additive, false otherwise.
loggerLevel - The Level to be associated with the Logger.
loggerName - The name of the Logger.
refs - An array of Appender names.
filter - A Filter.
Returns:
A new LoggerConfig.


Copyright © 1999-2012 Apache Software Foundation. All Rights Reserved.