SAP Logging API: Class BaseLog

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sap.tc.logging
Class BaseLog

java.lang.Object
  |
  +--com.sap.tc.logging.ExceptionHandling
        |
        +--com.sap.tc.logging.BaseLog

All Implemented Interfaces:: java.lang.Cloneable, IBaseLog, IObjectInfo

Direct Known Subclasses:: ReadLog

public abstract class BaseLog
extends ExceptionHandling
implements IBaseLog

Field Summary

static int STATUS_CLOSED


static int STATUS_INVALID


static int STATUS_OPENED


Constructor Summary

BaseLog()


Method Summary

void addFilter(IFilter filter)
          Adds another filter that controls messages flow via this log.

void close()
          Closes this log object.

java.lang.String getDescription()


java.lang.String getEncoding()
          Gets the canonical name of the character encoding that is used for this log.

IFilter getFilter(int index)
          Gets the filter that control messages flow via this log.

java.util.Collection getFilters()
          Gets the filters that control messages flow via this log.

java.lang.String getFooter()
          Sets the footer text of this log.

Formatter getFormatter()
          Gets the formatter that dictates the format of log records in this log.

java.lang.String getHeader()
          Gets the header text of this log.

int getMode()
          Get current working mode

java.lang.String getName()


java.lang.String getPattern()
          Gets the name pattern of this file log.

java.lang.String getSource()
          Gets the source name of this file log.

java.lang.String getVerInUse()


boolean isClosed()
          Check is this log closed.

boolean isOpened()
          Check is this log opened.

void open()
          Open this log object.

void removeFilter(IFilter filter)
          Removes a filter so that it no longer controls messages flow via this log.

void removeFilters()
          Removes all filters associated with this log.

void setDescription(java.lang.String value)


void setEncoding(java.lang.String encoding)
          Sets the named character encoding to be used for this log.

void setFormatter(Formatter formatter)
          Sets the formatter that dictates the format of log records in this log.

void setMode(int mode)
          Set current working mode.

void setName(java.lang.String value)


void setPattern(java.lang.String value)
          Sets the name pattern of this log.

void setSource(java.lang.String value)
          Sets the source name of this log.

int status()
          Status of this log object.

Methods inherited from class com.sap.tc.logging.ExceptionHandling

getException, getExceptions, handleException, handleException, resetException, throwException

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_INVALID

public static final int STATUS_INVALID

STATUS_CLOSED

public static final int STATUS_CLOSED

STATUS_OPENED

public static final int STATUS_OPENED

Constructor Detail

BaseLog

public BaseLog()

Method Detail