public class FileAppender<E> extends OutputStreamAppender<E>
Type | Property and Description |
---|---|
String |
rawFile
This method is used by derived classes to obtain the raw file property.
|
Modifier and Type | Field and Description |
---|---|
protected boolean |
append
Append to or truncate the file? The default value for this variable is
true , meaning that by default a FileAppender will
append to an existing file and not truncate it. |
protected String |
fileName
The name of the active log file.
|
encoder, lock
name, started
context
Constructor and Description |
---|
FileAppender() |
Modifier and Type | Method and Description |
---|---|
String |
getFile()
Returns the value of the File property.
|
boolean |
getLazy()
Gets the enable status of lazy initialization of the file output
stream
|
boolean |
isAppend()
Returns the value of the Append property.
|
boolean |
isPrudent() |
protected boolean |
openFile(String filename)
Sets and opens the file where the log output will go.
|
String |
rawFileProperty()
This method is used by derived classes to obtain the raw file property.
|
void |
setAppend(boolean append) |
void |
setFile(String file)
The File property takes a string value which should be the name of
the file to append to.
|
void |
setLazy(boolean enable)
Enables/disables lazy initialization of the file output stream.
|
void |
setPrudent(boolean prudent)
When prudent is set to true, file appenders from multiple JVMs can safely
write to the same file.
|
void |
start()
If the value of File is not
null , then
openFile(java.lang.String) is called with the values of File and
Append properties. |
protected void |
subAppend(E event)
Actual writing occurs here.
|
protected void |
writeOut(E event) |
append, closeOutputStream, getEncoder, getOutputStream, setEncoder, setLayout, setOutputStream, stop
addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext
public final String rawFileProperty
protected boolean append
true
, meaning that by default a FileAppender
will
append to an existing file and not truncate it.protected String fileName
public void setFile(String file)
file
- path to destination log filepublic boolean isAppend()
public final String rawFileProperty()
public String getFile()
public void start()
null
, then
openFile(java.lang.String)
is called with the values of File and
Append properties.start
in interface LifeCycle
start
in class OutputStreamAppender<E>
protected boolean openFile(String filename) throws IOException
Sets and opens the file where the log output will go. The specified file must be writable.
If there was already an opened file, then the previous file is closed first.
Do not use this method directly. To configure a FileAppender or one of its subclasses, set its properties one by one and then call start().
filename
- The path to the log file.IOException
- file could not be openedpublic boolean isPrudent()
setPrudent(boolean)
public void setPrudent(boolean prudent)
prudent
- whether to enable prudent modepublic void setAppend(boolean append)
public boolean getLazy()
public void setLazy(boolean enable)
enable
- true to enable lazy initialization; false otherwiseprotected void writeOut(E event) throws IOException
writeOut
in class OutputStreamAppender<E>
IOException
protected void subAppend(E event)
OutputStreamAppender
Most subclasses of WriterAppender
will need to override this
method.
subAppend
in class OutputStreamAppender<E>
event
- the log eventCopyright © 2005–2014 QOS.ch. All rights reserved.