org.rdtdm.helpers.log
Class Logging

java.lang.Object
  |
  +--org.rdtdm.helpers.log.Logging

public class Logging

extends java.lang.Object

Logging erlaubt das Protokollieren des Programmablauf incl. Fehlermeldungen und anderen Ausgaben. Dabei werden Ausgaben nur f?r angemeldete Klassen vorgenommen und anhand von einem Protokolllevel eingeschr?nkt

Copyright (c) 2001 by Dirk Münstermann
All Rights Reserved

Version:

$Revision: 1.1 $ ($Date: 2001/09/26 12:01:12 $)

Changelog:

 $Log: Logging.java,v $
 Revision 1.1  2001/09/26 12:01:12  dirk
 init

 

Author:

Dirk Münstermann email

Field Summary

private static boolean	addDateTime Legt fest, ob die Ausgabedatei um einen DateTime-String erweitert eird, der die aktuelle Zeit der Erzeugung anzeigt.
static int	DEBUG Protokolllevel-Type Debug
private static boolean	enable Legt fest, ob eine Ausgabe erfolgt oder nicht.
static int	ERROR Protokolllevel-Type ERROR
static int	EXCEPTION Protokolllevel-Type Exception
static int	FATAL Protokolllevel-Type Fatal
static int	FATALERROR Protokolllevel-Type FatalError
private static java.lang.String	filename
private static java.util.HashSet	keys Liste der Klassen, die eine Ausgabe erzeugen d?rfen.
static java.lang.String[]	LEVELLABEL
private static int	loglevel Legt den LogLevel fest. -1 steht f?r alles wird ausgegeben.
static int	MAX Maximum der Protokolllevel-Typen
static int	MIN Minimum der Protokolllevel-Typen
static int	NOLEVEL
private static java.io.PrintStream	output PrintStream f?r die Ausgabe
private static long	starttime
static int	STATUS Protokolllevel-Type Status
static int	TIME Protokolllevel-Type TIME
static int	WARNING Protokolllevel-Type Warnungen

Constructor Summary

Logging()

Method Summary

static void	addKey(java.lang.Class oclass) F?gt eine Klasse mit in die Liste der zu protokollierenden Klassen ein.
static void	addKey(java.lang.Object obj) F?gt eine Klasse mit in die Liste der zu protokollierenden Klassen ein.
static void	addKey(java.lang.String classname) F?gt eine Klasse mit in die Liste der zu protokollierenden Klassen ein.
static void	clearKeys()
static void	close() Schlie?t den Stream f?r die Ausgabe.
private static boolean	containsKey(java.lang.String key)
private static java.lang.String	createMessage(Log log)
static int	getLevel() Liefert den aktuellen Protokollierlevel zurueck.
static java.lang.String	getLevelStr() Liefert den aktuellen Protokollierlevel zurueck.
static void	init()
static void	init(boolean enable)
static void	init(java.io.File logfile, boolean enable) Initialisiert das Logging f?r die Ausgabe in eine Datei und legt fest, ob ?berhaupt eine Ausgabe erfolgt.
static void	init(java.io.PrintStream out, boolean enable)
static void	init(java.lang.String logfile, boolean enable)
static boolean	isAddDateTime() Liefert true der Dateiname bei der Ausgabe in eine Datei um einen String der aktuellen Uhrzeit + Datum erweitert soll
private static boolean	isDuplicate(java.lang.String logmessage)
static boolean	isEnable() Liefert true wenn das Protokolliern aktiviert ist.
private static boolean	isLevelOK(int level)
private static boolean	isPrintable(int level, java.lang.Class oclass) Liefert true , wenn eine Ausgabe erfolgen soll.
private static boolean	isPrintable(int level, java.lang.Object obj) Liefert true , wenn eine Ausgabe erfolgen soll.
static void	logDebug(java.lang.Object obj, java.lang.String message)
static void	logDebug(java.lang.String message)
static void	logError(java.lang.Object obj, java.lang.String message)
static void	logError(java.lang.String message)
static void	logException(java.lang.Object obj, java.lang.String message, java.lang.Throwable ex)
static void	logException(java.lang.String message, java.lang.Throwable ex)
static void	logFatal(java.lang.Object obj, java.lang.String message)
static void	logFatal(java.lang.String message)
static void	logStatus(java.lang.Object obj, java.lang.String message)
static void	logStatus(java.lang.String message)
static void	logTime()
static void	logTime(java.lang.Object obj)
static void	logWarning(java.lang.Object obj, java.lang.String message)
static void	logWarning(java.lang.String message)
static void	main(java.lang.String[] args) Testumgebung
static void	print(int level, java.lang.String message)
static void	print(Log log)
static void	print(java.lang.Object obj, int level, java.lang.String message)
static void	print(java.lang.Object obj, java.lang.String message)
static void	print(java.lang.String message)
static void	println()
static void	println(int level)
static void	println(int level, java.lang.String message)
static void	println(int level, java.lang.String message, java.lang.Throwable ex)
static void	println(Log log)
static void	println(java.lang.Object obj, int level, java.lang.String message)
static void	println(java.lang.Object obj, int level, java.lang.String message, java.lang.Throwable ex)
static void	println(java.lang.Object obj, java.lang.String message)
static void	println(java.lang.String message)
static void	removeKey(java.lang.Class oclass) L?scht eine Klasse aus der Liste der zu protokollierenden Klassen.
static void	removeKey(java.lang.Object obj) L?scht eine Klasse aus der Liste der zu protokollierenden Klassen.
static void	setAddDateTime(boolean b) Aktiviert / Deaktiviert die Erweiterung des Dateinamens um einen String mit der aktuellen Uhrzeit + Datum.
static void	setEnable(boolean b) Aktiviert bzw.
static void	setLevel(int level) Setzt den Protokollierlevel fest.
static void	setLevelStr(java.lang.String level) Setzt den Protokollierlevel fest.
static void	setOutput(java.io.PrintStream out) Setzt die Ausgabe f?r die Protokollierung.
static void	startTimer()
static void	startTimer(java.lang.Object obj)
static java.lang.String	staticToString()
static void	stopTimer()
static void	stopTimer(java.lang.Object obj)

Methods inherited from class java.lang.Object

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

Field Detail

output

private static java.io.PrintStream output

PrintStream f?r die Ausgabe

filename

private static java.lang.String filename

enable

private static boolean enable

Legt fest, ob eine Ausgabe erfolgt oder nicht.

addDateTime

private static boolean addDateTime

Legt fest, ob die Ausgabedatei um einen DateTime-String erweitert eird, der die aktuelle Zeit der Erzeugung anzeigt.

loglevel

private static int loglevel

Legt den LogLevel fest. -1 steht f?r alles wird ausgegeben.

keys

private static java.util.HashSet keys

Liste der Klassen, die eine Ausgabe erzeugen d?rfen. Ist diese Liste leer, d?rfen alle Klassen eine Ausgabe erzeugen.

starttime

private static long starttime

NOLEVEL

public static final int NOLEVEL

See Also:

Constant Field Values

MIN

public static final int MIN

Minimum der Protokolllevel-Typen

See Also:

Constant Field Values

DEBUG

public static final int DEBUG

Protokolllevel-Type Debug

See Also:

Constant Field Values

STATUS

public static final int STATUS

Protokolllevel-Type Status

See Also:

Constant Field Values

WARNING

public static final int WARNING

Protokolllevel-Type Warnungen

See Also:

Constant Field Values

EXCEPTION

public static final int EXCEPTION

Protokolllevel-Type Exception

See Also:

Constant Field Values

ERROR

public static final int ERROR

Protokolllevel-Type ERROR

See Also:

Constant Field Values

FATALERROR

public static final int FATALERROR

Protokolllevel-Type FatalError

See Also:

Constant Field Values

FATAL

public static final int FATAL

Protokolllevel-Type Fatal

See Also:

Constant Field Values

TIME

public static final int TIME

Protokolllevel-Type TIME

See Also:

Constant Field Values

MAX

public static final int MAX

Maximum der Protokolllevel-Typen

See Also:

Constant Field Values

LEVELLABEL

public static final java.lang.String[] LEVELLABEL

Constructor Detail

Logging

public Logging()

Method Detail

init

public static void init()

init

public static void init(boolean enable)

init

public static void init(java.lang.String logfile,
                        boolean enable)
                 throws LoggingException

LoggingException

init

public static void init(java.io.File logfile,
                        boolean enable)
                 throws LoggingException

Initialisiert das Logging f?r die Ausgabe in eine Datei und legt fest, ob ?berhaupt eine Ausgabe erfolgt. Wenn die Datei ohne Pfad angegeben wird und in den globalen Parametern @link org.rdtdm.helpers.GlobalParams ein Pfad f?r das Logging gesetzt ist, wird die Datei um diesen Pfad erweitert.

Parameters:

logfile -

enable -

Throws:

- LoggingException

LoggingException

init

public static void init(java.io.PrintStream out,
                        boolean enable)

setEnable

public static void setEnable(boolean b)

Aktiviert bzw. Deaktiviert das Protokolieren.

Parameters:

b - true aktiviert das Protokollieren, false deaktiviert es.

isEnable

public static boolean isEnable()

Liefert true wenn das Protokolliern aktiviert ist.

Returns:

true , wenn aktiv, sonst false .

setAddDateTime

public static void setAddDateTime(boolean b)

Aktiviert / Deaktiviert die Erweiterung des Dateinamens um einen String mit der aktuellen Uhrzeit + Datum.

Parameters:

b - true aktiviert die Erweiterung false deaktiviert sie.

isAddDateTime

public static boolean isAddDateTime()

Liefert true der Dateiname bei der Ausgabe in eine Datei um einen String der aktuellen Uhrzeit + Datum erweitert soll

Returns:

true , wenn aktiv, sonst false .

setLevel

public static void setLevel(int level)

Setzt den Protokollierlevel fest. Es werden nur Ausgaben protokolliert, die mit einem h?heren Wert erzeugt werden.

Parameters:

level - Protokollierlevel

getLevel

public static int getLevel()

Liefert den aktuellen Protokollierlevel zurueck.

Returns:

int der aktuelle Protokollierlevel

setLevelStr

public static void setLevelStr(java.lang.String level)

Setzt den Protokollierlevel fest. Es werden nur Ausgaben protokolliert, die mit einem h?heren Wert erzeugt werden.

Parameters:

level - Protokollierlevel

getLevelStr

public static java.lang.String getLevelStr()

Liefert den aktuellen Protokollierlevel zurueck.

Returns:

int der aktuelle Protokollierlevel

addKey

public static void addKey(java.lang.Object obj)

F?gt eine Klasse mit in die Liste der zu protokollierenden Klassen ein. D.h. alle Ausgaben (die dem LogLevel gen?gen) von diesen Klassen werden protokolliert. Ist die Liste der Klassen leer, werden alle Klassen bei der Protokollierung ber?cksichtigt.

Parameters:

obj - Eine spezielle Instanz der zu protokollierenden Klasse.

addKey

public static void addKey(java.lang.Class oclass)

F?gt eine Klasse mit in die Liste der zu protokollierenden Klassen ein. D.h. alle Ausgaben (die dem LogLevel gen?gen) von diesen Klassen werden protokolliert. Ist die Liste der Klassen leer, werden alle Klassen bei der Protokollierung ber?cksichtigt.

Parameters:

oclass - die zu protokollierende Klasse.

addKey

public static void addKey(java.lang.String classname)

F?gt eine Klasse mit in die Liste der zu protokollierenden Klassen ein. D.h. alle Ausgaben (die dem LogLevel gen?gen) von diesen Klassen werden protokolliert. Ist die Liste der Klassen leer, werden alle Klassen bei der Protokollierung ber?cksichtigt.

Parameters:

classname - Der Name der zu protokollierende Klasse.

removeKey

public static void removeKey(java.lang.Object obj)

L?scht eine Klasse aus der Liste der zu protokollierenden Klassen.

Parameters:

obj - Eine Instanz der zu protokollierenden Klasse.

removeKey

public static void removeKey(java.lang.Class oclass)

L?scht eine Klasse aus der Liste der zu protokollierenden Klassen.

Parameters:

oclass - die zu protokollierende Klasse.

clearKeys

public static void clearKeys()

setOutput

public static void setOutput(java.io.PrintStream out)

Setzt die Ausgabe f?r die Protokollierung.

Parameters:

out - Ein PrintStream f?r die Ausgabe.

close

public static void close()

Schlie?t den Stream f?r die Ausgabe.

startTimer

public static void startTimer()

startTimer

public static void startTimer(java.lang.Object obj)

stopTimer

public static void stopTimer()

stopTimer

public static void stopTimer(java.lang.Object obj)

staticToString

public static java.lang.String staticToString()

logDebug

public static void logDebug(java.lang.Object obj,
                            java.lang.String message)

logDebug

public static void logDebug(java.lang.String message)

logStatus

public static void logStatus(java.lang.Object obj,
                             java.lang.String message)

logStatus

public static void logStatus(java.lang.String message)

logWarning

public static void logWarning(java.lang.Object obj,
                              java.lang.String message)

logWarning

public static void logWarning(java.lang.String message)

logError

public static void logError(java.lang.Object obj,
                            java.lang.String message)

logError

public static void logError(java.lang.String message)

logException

public static void logException(java.lang.Object obj,
                                java.lang.String message,
                                java.lang.Throwable ex)

logException

public static void logException(java.lang.String message,
                                java.lang.Throwable ex)

logFatal

public static void logFatal(java.lang.Object obj,
                            java.lang.String message)

logFatal

public static void logFatal(java.lang.String message)

logTime

public static void logTime()

logTime

public static void logTime(java.lang.Object obj)

println

public static void println()

print

public static void print(java.lang.String message)

println

public static void println(java.lang.String message)

println

public static void println(int level)

print

public static void print(java.lang.Object obj,
                         java.lang.String message)

println

public static void println(java.lang.Object obj,
                           java.lang.String message)

print

public static void print(int level,
                         java.lang.String message)

println

public static void println(int level,
                           java.lang.String message)

println

public static void println(int level,
                           java.lang.String message,
                           java.lang.Throwable ex)

print

public static void print(java.lang.Object obj,
                         int level,
                         java.lang.String message)

println

public static void println(java.lang.Object obj,
                           int level,
                           java.lang.String message)

println

public static void println(java.lang.Object obj,
                           int level,
                           java.lang.String message,
                           java.lang.Throwable ex)

print

public static void print(Log log)

println

public static void println(Log log)

createMessage

private static java.lang.String createMessage(Log log)

isDuplicate

private static boolean isDuplicate(java.lang.String logmessage)

isPrintable

private static boolean isPrintable(int level,
                                   java.lang.Object obj)

Liefert true , wenn eine Ausgabe erfolgen soll.

Parameters:

level - LogLevel

obj - Eine Instanz einer Klasse.

Returns:

true , wenn die Ausgabe erfolgen kann, sonst false .

isPrintable

private static boolean isPrintable(int level,
                                   java.lang.Class oclass)

Liefert true , wenn eine Ausgabe erfolgen soll.

Parameters:

level - LogLevel

oclass - die aufrufenden Klasse

Returns:

true , wenn die Ausgabe erfolgen kann, sonst false .

containsKey

private static boolean containsKey(java.lang.String key)

isLevelOK

private static boolean isLevelOK(int level)

main

public static void main(java.lang.String[] args)

Testumgebung