com.sap.tc.logging.interfaces

Interface IFileLog

All Superinterfaces:

Cloneable, ILog, IObjectInfo

All Known Implementing Classes:

FileLog

public interface IFileLog
extends ILog

Method Summary

int	getCnt() Gets the max count number of rotating fileset
long	getFileLength() Returns the length of the file(s).
String	getFileName() Gets the current file name represented by this FileLog.
int	getLimit() Gets the limit file size used for sequencing on the rotating output file
String	getParent() Returns the pathname string of this FileLog object's pattern's parent, or null if the pattern does not expand to a pathname that has a parent directory.
String	getPath() Returns the pathname string of the current file this FileLog object represent.
String	getPattern() Gets the file name pattern of this file log.
boolean	isAppend() Checks whether this file log writes messages to the end of the specified file rather than the beginning.

Methods inherited from interface com.sap.tc.logging.interfaces.ILog

addFilter, beLogged, close, flush, getEffectiveSeverity, getEncoding, getFilters, getFooter, getFormatter, getHeader, getLogTypeAccessibility, getNumberOfLogRecordsWritten, isAutoFlush, isClosed, isOpened, open, removeFilter, removeFilters, setAutoFlush, setEffectiveSeverity, setEncoding, setFormatter, setLogTypeAccessibility, status

Methods inherited from interface com.sap.tc.logging.interfaces.IObjectInfo

getDescription, getName, getVerInUse

Method Detail

isAppend

boolean isAppend()

Checks whether this file log writes messages to the end of the specified file rather than the beginning.

Returns:

true if and only if this file log writes messages to the end of the specified file rather than the beginning

getPattern

String getPattern()

Gets the file name pattern of this file log.

Returns:

File name pattern

getFileName

String getFileName()

Gets the current file name represented by this FileLog. Cann be null;

Returns:

The file name

getFileLength

long getFileLength()

Returns the length of the file(s).

Returns:

the length of this file, measured in bytes.

Throws:

IOException - if an I/O error occurs.

getLimit

int getLimit()

Gets the limit file size used for sequencing on the rotating output file

Returns:

Limit file size

getCnt

int getCnt()

Gets the max count number of rotating fileset

Returns:

Number of files in rotating fileset.

getPath

String getPath()

Returns the pathname string of the current file this FileLog object represent.

Returns:

The pathname

getParent

String getParent()

Returns the pathname string of this FileLog object's pattern's parent, or null if the pattern does not expand to a pathname that has a parent directory.

Returns:

The parent pathname

Access Rights

This class can be accessed from:

SC	DC
[sap.com] FRAMEWORK	[sap.com] tc/ddic/ddicruntime
[sap.com] ENGINEAPI	[sap.com] tc/logging
[sap.com] ENGFACADE	[sap.com] tc/bl/logging/api
[sap.com] CORE-TOOLS	[sap.com] com.sap.engine.client.lib
[sap.com] BRMS-FACADE	[sap.com] tc/brms/facade