com.aspose.email

Class FileAppender

java.lang.Object

com.aspose.email.Appender

com.aspose.email.FileAppender

All Implemented Interfaces:

IAppender, IDisposable

public final class FileAppender
extends Appender

Reprensents a file appender.

Constructor Summary

Constructors

Constructor and Description
FileAppender() Initializes a new instance of the FileAppender class.
FileAppender(String fileName) Initializes a new instance of the FileAppender class.
FileAppender(String fileName, boolean useDate) Initializes a new instance of the FileAppender class.
FileAppender(String fileName, boolean useDate, IFormatter formatter) Initializes a new instance of the FileAppender class.
FileAppender(String fileName, IFormatter formatter) Initializes a new instance of the FileAppender class.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(LogEntry logEntry) Appends the log entry information to the appender.
void	append(LogEntry[] logEntries) Appends a set of log entries to the appender.
void	appendHeader() Starts log file with specific header.
void	close() Closes the appender.
String	getEncoding() Gets or sets the encoding.
String	getFileName() Gets or sets file name.
boolean	getUseDate() Gets or sets value which indicates whether date is used for logging.
void	setEncoding(String value) Gets or sets the encoding.
void	setFileName(String value) Gets or sets file name.
void	setUseDate(boolean value) Gets or sets value which indicates whether date is used for logging.

Methods inherited from class com.aspose.email.Appender

dispose, dispose, finalize, getClosed, getFormatter, getInitialized, initialize, setFormatter

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileAppender

public FileAppender()

Initializes a new instance of the FileAppender class.

FileAppender

public FileAppender(String fileName)

Initializes a new instance of the FileAppender class.

Parameters:

fileName - The file name.

FileAppender

public FileAppender(String fileName,
            boolean useDate)

Initializes a new instance of the FileAppender class.

Parameters:

fileName - The file name.

useDate - Indicates if date is used in file name

FileAppender

public FileAppender(String fileName,
            IFormatter formatter)

Initializes a new instance of the FileAppender class.

Parameters:

fileName - The file name.

formatter - Log formatter

FileAppender

public FileAppender(String fileName,
            boolean useDate,
            IFormatter formatter)

Initializes a new instance of the FileAppender class.

Parameters:

fileName - The file name.

useDate - Indicates if date is used in file name

formatter - Log formatter

Method Detail

getFileName

public final String getFileName()

Gets or sets file name.

setFileName

public final void setFileName(String value)

Gets or sets file name.

getUseDate

public final boolean getUseDate()

Gets or sets value which indicates whether date is used for logging.

setUseDate

public final void setUseDate(boolean value)

Gets or sets value which indicates whether date is used for logging.

getEncoding

public final String getEncoding()

Gets or sets the encoding.

setEncoding

public final void setEncoding(String value)

Gets or sets the encoding.

append

public void append(LogEntry logEntry)

Appends the log entry information to the appender.

Specified by:

append in interface IAppender

Specified by:

append in class Appender

Parameters:

logEntry - The log entry.

appendHeader

public void appendHeader()

Starts log file with specific header.

Specified by:

appendHeader in interface IAppender

Overrides:

appendHeader in class Appender

append

public final void append(LogEntry[] logEntries)

Appends a set of log entries to the appender.

Parameters:

logEntries - A set of log entries to log.

close

public void close()

Closes the appender.

Overrides:

close in class Appender