/*\
* Copyright 2006 Klaus Rogall, Hamburg, Germany (klaus.rogall@web.de). All rights reserved.
* _____________________________________________________________________________________________________________________
*
* This class is "Open Source" as defined by the Open Source Initiative (OSI). You can redistribute it and/or modify it
* under the terms of the BSD License. The license text is appended to the end of this file.
\*/
package de.klaro.base.util;
/**
* Ein Logging-System definiert eine Schnittstelle fr Logging-Aufrufe, die unabhngig von der konkret verwendeten
* Logging-API ist.
*/
public interface LoggingSystem
{
/* ______________________________________________________________________________________________________________ *\
\* Konstanten */
/** Ein Logging-System, das alle Meldungen unterdrckt. */
public static final LoggingSystem NULL_LOGGING_SYSTEM = new NullLoggingSystem();
/* ______________________________________________________________________________________________________________ *\
\* Instanzmethoden */
/**
* Gibt eine Logging-Meldung auf dem Logger aus.
*
* @param level Der Meldungs-Level
* @param message Der Meldungstext
*/
public void log(LoggingLevel level,String message);
/**
* Gibt ein Throwable als Logging-Meldung auf dem Logger aus.
*
* @param level Der Meldungs-Level
* @param throwable Das Throwable
*/
public void log(LoggingLevel level,Throwable throwable);
/**
* Gibt eine Logging-Meldung mit Throwable auf dem Logger aus.
*
* @param level Der Meldungs-Level
* @param message Der Meldungstext
* @param throwable Das mit der Meldung assoziierte Throwable
*/
public void log(LoggingLevel level,String message,Throwable throwable);
/* ______________________________________________________________________________________________________________ *\
\* Klassen */
/**
* Default-Logging-System, das alle Ausgaben unterdrckt
*/
public class NullLoggingSystem extends Object implements LoggingSystem
{
/**
* Erzeugt ein Default-Logging-System.
*/
public NullLoggingSystem()
{
super();
}
/**
* Gibt eine Logging-Meldung auf dem Logger aus (diese Implementierung unterdrckt die Meldung).
*
* @param level Der Meldungs-Level
* @param message Der Meldungstext
*/
public void log(LoggingLevel level,String message)
{
// Keine Aktion
}
/**
* Gibt ein Throwable als Logging-Meldung auf dem Logger aus (diese Implementierung unterdrckt die Meldung).
*
* @param level Der Meldungs-Level
* @param throwable Das Throwable
*/
public void log(LoggingLevel level,Throwable throwable)
{
// Keine Aktion
}
/**
* Gibt eine Logging-Meldung mit Throwable auf dem Logger aus (diese Implementierung unterdrckt die Meldung).
*
* @param level Der Meldungs-Level
* @param message Der Meldungstext
* @param throwable Das mit der Meldung assoziierte Throwable
*/
public void log(LoggingLevel level,String message,Throwable throwable)
{
// Keine Aktion
}
}
/**
* Der Level einer Logging-Meldung
*/
public enum LoggingLevel
{
/** Debug logging. */
DEBUG("debug"),
/** Information logging. */
INFO("info"),
/** Warning logging. */
WARNING("warning"),
/** Error logging. */
ERROR("error");
private String description$;
/**
* Erzeugt ein Element der Aufzhlung.
*
* @param description Der Bezeichnung
*/
private LoggingLevel(String description)
{
description$ = description;
}
/**
* Liefert die Bezeichnung des Elements.
*
* @return Die Bezeichnung des Elements
*/
public String getDescription()
{
return description$;
}
/**
* Liefert eine String-Reprsentation des Elements.
*
* @return Die String-Reprsentation des Elements
*/
public String toString()
{
return description$;
}
}
}
/*\
* _____________________________________________________________________________________________________________________
*
* This software is distributed under the terms of the BSD License:
*
* Copyright 2006 Klaus Rogall, Hamburg, Germany (klaus.rogall@web.de). All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the distribution.
* - Neither the name of the Klaus Rogall nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* _____________________________________________________________________________________________________________________
\*/
