Logback Core Module 1.5.1 · ch.qos.logback.core.FileAppender

Modifier and Type	Field and Description
protected boolean	append Append to or truncate the file?
private FileSize	bufferSize
protected static String	COLLISION_WITH_EARLIER_APPENDER_URL
public static final long	DEFAULT_BUFFER_SIZE
protected String	fileName The name of the active log file.
private boolean	prudent

Access	Constructor and Description
public	FileAppender()

Method Summary

Modifier and Type	Method and Description
protected void	addErrorForCollision(String optionName, String optionValue, String appenderName)
protected boolean	checkForFileCollisionInPreviousFileAppenders()
public String	getFile() Returns the value of the File property.
public boolean	isAppend() Returns the value of the Append property.
public boolean	Returns: true if in prudent mode isPrudent()
public void	openFile(String The path to the log file. file_name) Sets and opens the file where the log output will go.
public final String	Returns: the value of the file property rawFileProperty() This method is used by derived classes to obtain the raw file property.
private void	releaseFileLock(FileLock fileLock)
private void	safeWriteBytes(byte[] byteArray)
private void	safeWriteOut(E event)
public void	setAppend(boolean append)
public void	setBufferSize(FileSize bufferSize)
public void	setFile(String file) The File property takes a string value which should be the name of the file to append to.
public void	setPrudent(boolean prudent) When prudent is set to true, file appenders from multiple JVMs can safely write to the same file.
public void	start() Overrides ch.qos.logback.core.OutputStreamAppender.start. Implements ch.qos.logback.core.spi.LifeCycle.start. If the value of File is not `null`, then `openFile` is called with the values of File and Append properties.
public void	stop() Overrides ch.qos.logback.core.OutputStreamAppender.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop. Stop this appender instance.
protected void	writeOut(E event) Overrides ch.qos.logback.core.OutputStreamAppender.writeOut.

Inherited from ch.qos.logback.core.OutputStreamAppender:: append closeOutputStream encoderClose encoderInit getEncoder getOutputStream isImmediateFlush setEncoder setImmediateFlush setLayout setOutputStream subAppend writeByteArrayToOutputStreamWithPossibleFlush

Field Detail

append	back to summary
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.

bufferSize	back to summary
private FileSize bufferSize

COLLISION_WITH_EARLIER_APPENDER_URL	back to summary
protected static String COLLISION_WITH_EARLIER_APPENDER_URL

DEFAULT_BUFFER_SIZE	back to summary
public static final long DEFAULT_BUFFER_SIZE

fileName	back to summary
protected String fileName The name of the active log file.

prudent	back to summary
private boolean prudent

Constructor Detail

FileAppender	back to summary
public FileAppender()

Method Detail

addErrorForCollision	back to summary
protected void addErrorForCollision(String optionName, String optionValue, String appenderName)

checkForFileCollisionInPreviousFileAppenders	back to summary
protected boolean checkForFileCollisionInPreviousFileAppenders()

getFile	back to summary
public String getFile() Returns the value of the File property. This method may be overridden by derived classes.

getFile

back to summary

public String getFile()

Returns the value of the File property.

This method may be overridden by derived classes.

isAppend	back to summary
public boolean isAppend() Returns the value of the Append property.

isPrudent	back to summary
public boolean isPrudent() Returns:boolean true if in prudent mode See Also `setPrudent(boolean)`

openFile	back to summary
public void openFile(String file_name) 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(). Parameters file_name:String The path to the log file.

openFile

back to summary

public void openFile(String file_name) 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().

Parameters

file_name:String: The path to the log file.

rawFileProperty	back to summary
public final String rawFileProperty() This method is used by derived classes to obtain the raw file property. Regular users should not be calling this method. Returns:String the value of the file property

rawFileProperty

back to summary

public final String rawFileProperty()

This method is used by derived classes to obtain the raw file property. Regular users should not be calling this method.

Returns:String: the value of the file property

releaseFileLock	back to summary
private void releaseFileLock(FileLock fileLock)

safeWriteBytes	back to summary
private void safeWriteBytes(byte[] byteArray)

safeWriteOut	back to summary
private void safeWriteOut(E event)

setAppend	back to summary
public void setAppend(boolean append)

setBufferSize	back to summary
public void setBufferSize(FileSize bufferSize)

setFile	back to summary
public void setFile(String file) The File property takes a string value which should be the name of the file to append to.

setPrudent	back to summary
public void setPrudent(boolean prudent) When prudent is set to true, file appenders from multiple JVMs can safely write to the same file.

start back to summary

start	back to summary
public void start() Overrides ch.qos.logback.core.OutputStreamAppender.start. Implements ch.qos.logback.core.spi.LifeCycle.start. If the value of File is not `null`, then `openFile` is called with the values of File and Append properties.

public void start()

Overrides ch.qos.logback.core.OutputStreamAppender.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.

If the value of File is not null, then openFile is called with the values of File and Append properties.

stop	back to summary
public void stop() Overrides ch.qos.logback.core.OutputStreamAppender.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop. Doc from ch.qos.logback.core.OutputStreamAppender.stop. Stop this appender instance. The underlying stream or writer is also closed. Stopped appenders cannot be reused. Annotations @Override

stop

back to summary

public void stop()

Overrides ch.qos.logback.core.OutputStreamAppender.stop.

Implements ch.qos.logback.core.spi.LifeCycle.stop.

Doc from ch.qos.logback.core.OutputStreamAppender.stop.

Stop this appender instance. The underlying stream or writer is also closed.

Stopped appenders cannot be reused.

Annotations