org.apache.logging.log4j.core.appender
Class RollingFileAppender
java.lang.Object
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender
org.apache.logging.log4j.core.appender.RollingFileAppender
- All Implemented Interfaces:
- Appender, Filterable, LifeCycle
public final class RollingFileAppender
- extends AbstractOutputStreamAppender
An appender that writes to files andd can roll over at intervals.
Method Summary |
void |
append(LogEvent event)
Write the log entry rolling over the file when required. |
static RollingFileAppender |
createAppender(String fileName,
String filePattern,
String append,
String name,
String bufferedIO,
String immediateFlush,
TriggeringPolicy policy,
RolloverStrategy strategy,
Layout layout,
Filter filter,
String suppress,
Configuration config)
Create a RollingFileAppender. |
String |
getFileName()
Returns the File name for the Appender. |
String |
getFilePattern()
Returns the file pattern used when rolling over. |
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender |
close, error, error, error, getHandler, getLayout, getName, isExceptionSuppressed, isStarted, setHandler, toString |
append
public void append(LogEvent event)
- Write the log entry rolling over the file when required.
- Specified by:
append
in interface Appender
- Overrides:
append
in class AbstractOutputStreamAppender
- Parameters:
event
- The LogEvent.
getFileName
public String getFileName()
- Returns the File name for the Appender.
- Returns:
- The file name.
getFilePattern
public String getFilePattern()
- Returns the file pattern used when rolling over.
- Returns:
- The file pattern.
createAppender
public static RollingFileAppender createAppender(String fileName,
String filePattern,
String append,
String name,
String bufferedIO,
String immediateFlush,
TriggeringPolicy policy,
RolloverStrategy strategy,
Layout layout,
Filter filter,
String suppress,
Configuration config)
- Create a RollingFileAppender.
- Parameters:
fileName
- The name of the file that is actively written to. (required).filePattern
- The pattern of the file name to use on rollover. (required).append
- If true, events are appended to the file. If false, the file
is overwritten when opened. Defaults to "true"name
- The name of the Appender (required).bufferedIO
- When true, I/O will be buffered. Defaults to "true".immediateFlush
- When true, events are immediately flushed. Defaults to "true".policy
- The triggering policy. (required).strategy
- The rollover strategy. Defaults to DefaultRolloverStrategy.layout
- The layout to use (defaults to the default PatternLayout).filter
- The Filter or null.suppress
- "true" if exceptions should be hidden from the application, "false" otherwise.
The default is "true".config
- The Configuration.
- Returns:
- A RollingFileAppender.
Copyright © 1999-2012 Apache Software Foundation. All Rights Reserved.