abk.logging
Class ALogger

java.lang.Object
  abk.logging.ACoreLogger
      abk.logging.ALogger

Direct Known Subclasses:

ALoggerFactory.LazyLogger

public abstract class ALogger
extends ACoreLogger

Interfaz para simplificar y unificar la gestión de Logger's.

Se definen métodos que facilitan la generación de mensajes para las trazas:

• xxxx(AMessageBuilder builder, Object... args)
• xxxx(AMessageBuilder builder, Throwable t, Object... args)
• xxxx(String pattern, Object... args)
• xxxx(String pattern, Throwable t, Object... args)
• xxxx(Throwable t)
• isXxxxEnabled()

Los métodos xxxx() se mapean como sigue:

• Level.SEVERE: error
• Level.WARNING: warn
• Level.INFO: info
• Level.CONFIG: config
• Level.FINE: debug
• Level.FINER: trace

Estos métodos tienen otros semejantes en los que se especifica el nivel de forma explícita:

• log(Level, AMessageKey)
• log(Level, AMessageKey, Throwable)
• log(Level, String, Object...)
• log(Level, String, Throwable, Object...)
• log(Level, Throwable)
• ACoreLogger.isEnabledFor(Level)

Además se definen métodos pensados para mostrar trazas con nivel severo en pruebas de test:

• log(boolean, String, Object...) evalúa un resultado y muestra el mensaje si se obtiene false. Por ejemplo:

   assertTrue(LOGGER.log(3 == n, "n={0} debería ser 3.", n));
   

• success(Runnable, String, Object...) evalúa si una tarea se ejecuta sin lanzar ninguna excepción. Si no es así, muestra una traza componiendo el mensaje con el patrón y los argumentos correspondientes. Por ejemplo:

   assertTrue(LOGGER.success(() -> { hazAlgo(); }, "El proceso no debería haber fallado"));
   

• fails(Runnable, String, Object...) evalúa si una tarea se ejecuta lanzando una excepción. Si no es así, muestra una traza componiendo el mensaje con el patrón y los argumentos correspondientes. Por ejemplo:

   assertTrue(LOGGER.fails(() -> { hazAlgo(); }, "El proceso debería haber fallado"));
   

Constructor Summary

protected

ALogger(String logName, Integer classStart)

Method Summary

void	config(AMessageKey builder)
void	config(AMessageKey builder, Throwable t)
void	config(String pattern, Object... args)
void	config(String pattern, Throwable t, Object... args)
void	config(Throwable t)
void	debug(AMessageKey builder)
void	debug(AMessageKey builder, Throwable t)
void	debug(String pattern, Object... args)
void	debug(String pattern, Throwable t, Object... args)
void	error(AMessageKey builder)
void	error(AMessageKey builder, Throwable t)
void	error(String pattern, Object... args)
void	error(String pattern, Throwable t, Object... args)
void	error(Throwable t)
boolean	fails(Runnable runner, String pattern, Object... args) Emite una traza si durante la ejecución de un Runnable no se produce una excepción.
private static ALogger	get_logger(String logName, Integer classStart) Obtiene un logger con nombre de logger dado, y anotando cuál es la parte de nombre de clase de ese logName.
static ALogger	getLogger(Class<?> clazz)
static ALogger	getLogger(String logName) Devuelve un logger con el nombre especificado, sin especificar el nombre de la clase.
static ALogger	getLogger(String prefix, Class<?> clazz)
static ALogger	getLogger(String prefix, String className) Devuelve un logger suyo nombre se construye a partir de un prefijo y de un nombre de clase, separados por un punto.
void	info(AMessageKey builder)
void	info(AMessageKey builder, Throwable t)
void	info(String pattern, Object... args)
void	info(String pattern, Throwable t, Object... args)
void	info(Throwable t)
boolean	isConfigEnabled()
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isInfoEnabled()
boolean	isTraceEnabled()
boolean	isWarnEnabled()
boolean	log(boolean test, String pattern, Object... args) Lanza una traza de nivel nivel Level.SEVERE si el resultado booleano de un test es false.
void	log(Level level, AMessageKey builder)
void	log(Level level, AMessageKey builder, Throwable t)
void	log(Level level, String pattern, Object... args)
void	log(Level level, String pattern, Throwable t, Object... args) Solicita la emisión de una traza con un nivel de mensaje fijado.
void	log(Level level, Throwable t)
boolean	success(Runnable runner, String pattern, Object... args) Emite una traza si durante la ejecución de un Runnable se produce una excepción.
void	trace(AMessageKey builder)
void	trace(AMessageKey builder, Throwable t)
void	trace(String pattern, Object... args)
void	trace(String pattern, Throwable t, Object... args)
void	trace(Throwable t)
void	warn(AMessageKey builder)
void	warn(AMessageKey builder, Throwable t)
void	warn(String pattern, Object... args)
void	warn(String pattern, Throwable t, Object... args)
void	warn(Throwable t)

Methods inherited from class abk.logging.ACoreLogger

getClassName, getClassStart, getLevel, getLogName, isEnabledFor, log, setLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

ALogger

protected ALogger(String logName,
                  Integer classStart)

Method Detail

get_logger

private static final ALogger get_logger(String logName,
                                        Integer classStart)

Obtiene un logger con nombre de logger dado, y anotando cuál es la parte de nombre de clase de ese logName.

Parameters:

logName - Nombre completo del logger.

classStart - Posición dentro de logName a partir de la cual empieza el nombre de la clase, o un número negativo si no hay nombre de clase en el logName.

Returns:

Logger asociado a logName.

Throws:

NullArgumentException - si logName es nulo.

IllegalArgumentException - si logName está vacío.

getLogger

public static final ALogger getLogger(String logName)

Devuelve un logger con el nombre especificado, sin especificar el nombre de la clase.

Parameters:

logName - Nombre del logger.

Returns:

Logger asociado a logName.

getLogger

public static final ALogger getLogger(String prefix,
                                      String className)

Devuelve un logger suyo nombre se construye a partir de un prefijo y de un nombre de clase, separados por un punto.

Parameters:

prefix - Prefijo del nombre del logger. Si es nulo o vacío no se añade el prefijo, ni el punto que lo separa del nombre de clase.

className - Nombre de la clase. Si es nula o vacía, no hay nombre de clase, ni el punto que la precede.

Returns:

Logger asociado a ese prefijo y nombre de clase.

getLogger

public static final ALogger getLogger(Class<?> clazz)

getLogger

public static final ALogger getLogger(String prefix,
                                      Class<?> clazz)

log

public void log(Level level,
                String pattern,
                Throwable t,
                Object... args)

Solicita la emisión de una traza con un nivel de mensaje fijado. La emisión de la traza será efectiva en función de la configuración del sistema de trazas que se esté usando.

Parameters:

level - Nivel de la traza.

pattern - Patrón para construir el mensaje, conforme MessageFormat.

t - Error vinculado al mensaje, o null si no hay error vinculado al mensaje.

args - Argumentos que se usarán para construir el mensaje.

log

public void log(Level level,
                AMessageKey builder,
                Throwable t)

log

public void log(Level level,
                Throwable t)

log

public void log(Level level,
                String pattern,
                Object... args)

log

public void log(Level level,
                AMessageKey builder)

isErrorEnabled

public boolean isErrorEnabled()

isWarnEnabled

public boolean isWarnEnabled()

isInfoEnabled

public boolean isInfoEnabled()

isConfigEnabled

public boolean isConfigEnabled()

isDebugEnabled

public boolean isDebugEnabled()

isTraceEnabled

public boolean isTraceEnabled()

error

public void error(Throwable t)

error

public void error(String pattern,
                  Throwable t,
                  Object... args)

error

public void error(String pattern,
                  Object... args)

error

public void error(AMessageKey builder,
                  Throwable t)

error

public void error(AMessageKey builder)

warn

public void warn(Throwable t)

warn

public void warn(String pattern,
                 Throwable t,
                 Object... args)

warn

public void warn(String pattern,
                 Object... args)

warn

public void warn(AMessageKey builder)

warn

public void warn(AMessageKey builder,
                 Throwable t)

info

public void info(Throwable t)

info

public void info(String pattern,
                 Throwable t,
                 Object... args)

info

public void info(String pattern,
                 Object... args)

info

public void info(AMessageKey builder,
                 Throwable t)

info

public void info(AMessageKey builder)

config

public void config(Throwable t)

config

public void config(String pattern,
                   Throwable t,
                   Object... args)

config

public void config(String pattern,
                   Object... args)

config

public void config(AMessageKey builder,
                   Throwable t)

config

public void config(AMessageKey builder)

debug

public void debug(String pattern,
                  Throwable t,
                  Object... args)

debug

public void debug(String pattern,
                  Object... args)

debug

public void debug(AMessageKey builder,
                  Throwable t)

debug

public void debug(AMessageKey builder)

trace

public void trace(Throwable t)

trace

public void trace(String pattern,
                  Throwable t,
                  Object... args)

trace

public void trace(String pattern,
                  Object... args)

trace

public void trace(AMessageKey builder,
                  Throwable t)

trace

public void trace(AMessageKey builder)

log

public boolean log(boolean test,
                   String pattern,
                   Object... args)

Lanza una traza de nivel nivel Level.SEVERE si el resultado booleano de un test es false.

Parameters:

test - Resultado de un test realizado.

pattern - Patrón para dar formato al mensaje de respuesta.

args - Argumentos que se aplican al patrón para construir el mensaje que se muestra.

Returns:

Resultado del test, test.

success

public boolean success(Runnable runner,
                       String pattern,
                       Object... args)

Emite una traza si durante la ejecución de un Runnable se produce una excepción. La traza se emite con nivel Level.SEVERE. El planteamiento del método es que el test tiene éxito si no se produce fallo.

Parameters:

runner - Tarea de test.

pattern - Patrón del mensaje.

args - Argumentos para construir el patrón del mensaje.

Returns:

true si la tarea se ejecutó correctamente, y no se emitió el mensaje. false si se capturó una excepción y se emitió el mensaje asociado.

fails

public boolean fails(Runnable runner,
                     String pattern,
                     Object... args)

Emite una traza si durante la ejecución de un Runnable no se produce una excepción. La traza se emite con nivel Level.SEVERE. El planteamiento del método es que el test tiene éxito si se produce fallo.

Parameters:

runner - Tarea de test.

pattern - Patrón del mensaje.

args - Argumentos para construir el patrón del mensaje.

Returns:

true si se capturó una excepción y no se emitió el mensaje asociado. false si la tarea se ejecutó correctamente, y se emitió el mensaje.