org.apache.logging.log4j.core.appender
Class FileAppender
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.FileAppender
- All Implemented Interfaces:
- Appender, Filterable, LifeCycle
public final class FileAppender
- extends AbstractOutputStreamAppender
File Appender.
Method Summary |
static FileAppender |
createAppender(String fileName,
String append,
String locking,
String name,
String immediateFlush,
String ignore,
String bufferedIO,
Layout<? extends Serializable> layout,
Filter filter,
String advertise,
String advertiseURI,
Configuration config)
Create a File Appender. |
String |
getFileName()
Returns the file name this appender is associated with. |
void |
stop()
Stop the Appender. |
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender |
error, error, error, getHandler, getLayout, getName, ignoreExceptions, isStarted, parseInt, setHandler, toString |
stop
public void stop()
- Description copied from class:
AbstractAppender
- Stop the Appender.
- Specified by:
stop
in interface LifeCycle
- Overrides:
stop
in class AbstractOutputStreamAppender
getFileName
public String getFileName()
- Returns the file name this appender is associated with.
- Returns:
- The File name.
createAppender
public static FileAppender createAppender(String fileName,
String append,
String locking,
String name,
String immediateFlush,
String ignore,
String bufferedIO,
Layout<? extends Serializable> layout,
Filter filter,
String advertise,
String advertiseURI,
Configuration config)
- Create a File Appender.
- Parameters:
fileName
- The name and path of the file.append
- "True" if the file should be appended to, "false" if it should be overwritten.
The default is "true".locking
- "True" if the file should be locked. The default is "false".name
- The name of the Appender.immediateFlush
- "true" if the contents should be flushed on every write, "false" otherwise. The default
is "true".ignore
- If "true"
(default) exceptions encountered when appending events are logged; otherwise
they are propagated to the caller.bufferedIO
- "true" if I/O should be buffered, "false" otherwise. The default is "true".layout
- The layout to use to format the event. If no layout is provided the default PatternLayout
will be used.filter
- The filter, if any, to use.advertise
- "true" if the appender configuration should be advertised, "false" otherwise.advertiseURI
- The advertised URI which can be used to retrieve the file contents.config
- The Configuration
- Returns:
- The FileAppender.
Copyright © 1999-2013 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.