Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

cosmoworx.log
Interface Logger  view Logger download Logger.java

All Superinterfaces:
LogSettings
All Known Implementing Classes:
AbstractLogger

public interface Logger
extends LogSettings

The Logger interface should be implemented by any class that wants to write log entries in a specific way. A class that has implemented the Logger interface can be registered with the Log class and receive log entries. The Logger class then writes the log entry according to its specific implementation.


Field Summary
 
Fields inherited from interface cosmoworx.log.LogSettings
ALL, CONFIG, DEBUG, ERROR, FATAL, INFO, NONE, WARN
 
Method Summary
 int getLevel()
          Gets the level that this Logger uses to write log entries.
 java.lang.String getMode()
          Sets the mode that this Logger uses to write log entries.
 boolean getShowLevel()
          Gets whether the level is shown in the log message header.
 boolean getShowMode()
          Gets whether the mode is shown in the log message header.
 boolean getShowSource()
          Gets whether the source is shown in the log message header.
 boolean getShowTimestamp()
          Sets whether the timestamp is shown in the log message header.
 void setLevel(int aiLevel)
          Sets the level that this Logger will use to write log entries.
 void setMode(java.lang.String asMode)
          Sets the mode that this Logger uses to write log entries.
 void setShowLevel(boolean abShow)
          Sets whether the level is shown in the log message header.
 void setShowMode(boolean abShow)
          Sets whether the mode is shown in the log message header.
 void setShowSource(boolean abShow)
          Sets whether the source is shown in the log message header.
 void setShowTimestamp(boolean abShow)
          Sets whether the timestamp is shown in the log message header.
 void write(java.lang.Object asSource, java.lang.String asMode, int aiLevel, java.lang.String asMessage)
          Called from the Log class to write a log entry.
 void write(java.lang.Object asSource, java.lang.String asMode, int aiLevel, java.lang.Throwable aoThrowable)
          Called from the Log class to write a log entry.
 void writeBlank()
          Called from the Log class to write a blank entry.
 void writeHeader(java.lang.Object aoSource, java.lang.String asMode, int aiLevel)
          Called from the Log class to write a header entry.
 void writeTimestamp()
          Called from the Log class to write a timestamp entry.
 

Method Detail

setLevel

public void setLevel(int aiLevel)
Sets the level that this Logger will use to write log entries.


getLevel

public int getLevel()
Gets the level that this Logger uses to write log entries.


setMode

public void setMode(java.lang.String asMode)
Sets the mode that this Logger uses to write log entries.


getMode

public java.lang.String getMode()
Sets the mode that this Logger uses to write log entries.


setShowTimestamp

public void setShowTimestamp(boolean abShow)
Sets whether the timestamp is shown in the log message header.


getShowTimestamp

public boolean getShowTimestamp()
Sets whether the timestamp is shown in the log message header.


setShowSource

public void setShowSource(boolean abShow)
Sets whether the source is shown in the log message header.


getShowSource

public boolean getShowSource()
Gets whether the source is shown in the log message header.


setShowMode

public void setShowMode(boolean abShow)
Sets whether the mode is shown in the log message header.


getShowMode

public boolean getShowMode()
Gets whether the mode is shown in the log message header.


setShowLevel

public void setShowLevel(boolean abShow)
Sets whether the level is shown in the log message header.


getShowLevel

public boolean getShowLevel()
Gets whether the level is shown in the log message header.


writeBlank

public void writeBlank()
Called from the Log class to write a blank entry.


writeTimestamp

public void writeTimestamp()
Called from the Log class to write a timestamp entry.


writeHeader

public void writeHeader(java.lang.Object aoSource,
                        java.lang.String asMode,
                        int aiLevel)
Called from the Log class to write a header entry.


write

public void write(java.lang.Object asSource,
                  java.lang.String asMode,
                  int aiLevel,
                  java.lang.String asMessage)
Called from the Log class to write a log entry. Each class that implements the Logger interface should use this method to write the log entry in a specific manner.


write

public void write(java.lang.Object asSource,
                  java.lang.String asMode,
                  int aiLevel,
                  java.lang.Throwable aoThrowable)
Called from the Log class to write a log entry. Each class that implements the Logger interface should use this method to write the log entry in a specific manner.