org.jboss.logging.tools.examples

Interface AppLogger

All Superinterfaces:

org.jboss.logging.BasicLogger

All Known Implementing Classes:

AppLogger_$logger

@MessageLogger(projectCode="CW")
 @ResolutionDoc(url="errors",
               suffix=".html")
public interface AppLogger
extends org.jboss.logging.BasicLogger

A common logger for the application.

Author:

James R. Perkins

Field Summary

Fields

Modifier and Type	Field and Description
static AppLogger	LOGGER

Method Summary

Modifier and Type	Method and Description
void	appVersion(CharSequence name, int major, int minor, int macro, String rel) Logs an informational message, once, indicating the applications version.
void	cacheSizeChanged(Collection<String> c) Logs an informational message indicating the cache size has changed and the size the cache is now.
void	cacheSizeChanged(Map<String,Object> map) Logs an informational message indicating the cache size has changed and the size the cache is now.
void	cacheSizeChanged(String... array) Logs an informational message indicating the cache size has changed and the size the cache is now.
void	closeFailure(Throwable cause, Object obj) Logs an error message indicating a failure to close the object.
void	encodingNotFound(String encoding, Charset dft) Logs a warning message indicating the encoding is invalid and a default encoding will be used.

Methods inherited from interface org.jboss.logging.BasicLogger

debug, debug, debug, debug, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugv, debugv, debugv, debugv, debugv, debugv, debugv, debugv, error, error, error, error, errorf, errorf, errorf, errorf, errorf, errorf, errorf, errorf, errorv, errorv, errorv, errorv, errorv, errorv, errorv, errorv, fatal, fatal, fatal, fatal, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, info, info, info, info, infof, infof, infof, infof, infof, infof, infof, infof, infov, infov, infov, infov, infov, infov, infov, infov, isDebugEnabled, isEnabled, isInfoEnabled, isTraceEnabled, log, log, log, log, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, trace, trace, trace, trace, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracev, tracev, tracev, tracev, tracev, tracev, tracev, tracev, warn, warn, warn, warn, warnf, warnf, warnf, warnf, warnf, warnf, warnf, warnf, warnv, warnv, warnv, warnv, warnv, warnv, warnv, warnv

Field Detail

LOGGER

static final AppLogger LOGGER

Method Detail

appVersion

@LogMessage
 @Once
 @Message(value="%s version %d.%d.%d.%s")
void appVersion(CharSequence name,
                                                                             int major,
                                                                             int minor,
                                                                             int macro,
                                                                             String rel)

Logs an informational message, once, indicating the applications version.

Parameters:

name - the name of the application

major - the major version

minor - the minor version

macro - the macro version

rel - the release suffix, e.g. Beta1, Final

closeFailure

@LogMessage(level=ERROR)
 @Message(id=100,
         value="Failure while closing %s")
void closeFailure(@Cause
                                                                                                        Throwable cause,
                                                                                                        Object obj)

Logs an error message indicating a failure to close the object.

Parameters:

cause - the cause of the error

obj - the object that failed closing

encodingNotFound

@LogMessage(level=WARN)
 @Message(id=101,
         value="Encoding %s could not be found. Defaulting to %s.")
void encodingNotFound(String encoding,
                                                                                                                                    Charset dft)

Logs a warning message indicating the encoding is invalid and a default encoding will be used.

Parameters:

encoding - the invalid encoding

dft - the default encoding

cacheSizeChanged

@LogMessage
 @Message(id=102,
         value="Cache size changed to \'%d\'")
 @ResolutionDoc(skip=true)
void cacheSizeChanged(@Transform(value=SIZE)
                                                                                                                              Collection<String> c)

Logs an informational message indicating the cache size has changed and the size the cache is now.

Parameters:

c - the collection holding the cache

cacheSizeChanged

@LogMessage
 @ResolutionDoc(skip=true)
void cacheSizeChanged(@Transform(value=SIZE)
                                                             String... array)

Logs an informational message indicating the cache size has changed and the size the cache is now.

Parameters:

array - the cache arracy

cacheSizeChanged

@LogMessage
 @ResolutionDoc(skip=true)
void cacheSizeChanged(@Transform(value=SIZE)
                                                             Map<String,Object> map)

Logs an informational message indicating the cache size has changed and the size the cache is now.

Parameters:

map - the map holding the cache