org.eclipse.fx.core.log

Interface Logger

public interface Logger

Logger interface delegating to real log framework implementation like log4j, java.util.logging, ...

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Logger.Level The log levels

Method Summary

Modifier and Type	Method and Description
void	debug(@NonNull java.lang.String message) convenience method for log(Level, String) with Logger.Level.DEBUG.
void	debug(@NonNull java.lang.String message, @NonNull java.lang.Throwable t) convenience method for log(Level, String, Throwable) with Logger.Level.DEBUG.
void	debugf(@NonNull java.lang.String pattern, java.lang.Object... args) convenience method for logf(Level, String, Object...) with Logger.Level.DEBUG.
void	debugf(@NonNull java.lang.String pattern, @NonNull java.lang.Throwable t, java.lang.Object... args) convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.DEBUG.
void	error(@NonNull java.lang.String message) convenience method for log(Level, String) with Logger.Level.ERROR.
void	error(@NonNull java.lang.String message, @NonNull java.lang.Throwable t) convenience method for log(Level, String, Throwable) with Logger.Level.ERROR.
void	errorf(@NonNull java.lang.String pattern, java.lang.Object... args) convenience method for logf(Level, String, Object...) with Logger.Level.ERROR.
void	errorf(@NonNull java.lang.String pattern, @NonNull java.lang.Throwable t, java.lang.Object... args) convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.ERROR.
void	fatal(@NonNull java.lang.String message) convenience method for log(Level, String) with Logger.Level.FATAL.
void	fatal(@NonNull java.lang.String message, @NonNull java.lang.Throwable t) convenience method for log(Level, String, Throwable) with Logger.Level.FATAL.
void	fatalf(@NonNull java.lang.String pattern, java.lang.Object... args) convenience method for logf(Level, String, Object...) with Logger.Level.FATAL.
void	fatalf(@NonNull java.lang.String pattern, @NonNull java.lang.Throwable t, java.lang.Object... args) convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.FATAL.
void	info(@NonNull java.lang.String message) convenience method for log(Level, String) with Logger.Level.INFO.
void	info(@NonNull java.lang.String message, @NonNull java.lang.Throwable t) convenience method for log(Level, String, Throwable) with Logger.Level.INFO.
void	infof(@NonNull java.lang.String pattern, java.lang.Object... args) convenience method for logf(Level, String, Object...) with Logger.Level.INFO.
void	infof(@NonNull java.lang.String pattern, @NonNull java.lang.Throwable t, java.lang.Object... args) convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.INFO.
boolean	isEnabled(Logger.Level level) checks whether the given log level is enabled for this logger.
void	log(@NonNull Logger.Level level, @NonNull java.lang.String message) logs a message in the specified log level.
void	log(@NonNull Logger.Level level, @NonNull java.lang.String message, @NonNull java.lang.Throwable t) logs a message and an exception in the specified log level
void	logf(@NonNull Logger.Level level, @NonNull java.lang.String pattern, java.lang.Object... args) logs a formatted message in the specified log level.
void	logf(@NonNull Logger.Level level, @NonNull java.lang.String pattern, @NonNull java.lang.Throwable t, java.lang.Object... args) logs a formatted message in the specified log level.
void	trace(@NonNull java.lang.String message) convenience method for log(Level, String) with Logger.Level.TRACE.
void	trace(@NonNull java.lang.String message, @NonNull java.lang.Throwable t) convenience method for log(Level, String, Throwable) with Logger.Level.TRACE.
void	tracef(@NonNull java.lang.String pattern, java.lang.Object... args) convenience method for logf(Level, String, Object...) with Logger.Level.TRACE.
void	tracef(@NonNull java.lang.String pattern, @NonNull java.lang.Throwable t, java.lang.Object... args) convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.TRACE.
void	warning(@NonNull java.lang.String message) convenience method for log(Level, String) with Logger.Level.WARNING.
void	warning(@NonNull java.lang.String message, @NonNull java.lang.Throwable t) convenience method for log(Level, String, Throwable) with Logger.Level.WARNING.
void	warningf(@NonNull java.lang.String pattern, java.lang.Object... args) convenience method for logf(Level, String, Object...) with Logger.Level.WARNING.
void	warningf(@NonNull java.lang.String pattern, @NonNull java.lang.Throwable t, java.lang.Object... args) convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.WARNING.

Method Detail

log

void log(@NonNull Logger.Level level,
         @NonNull java.lang.String message)

logs a message in the specified log level.

Parameters:

level - the Log Level

message - the message

log

void log(@NonNull Logger.Level level,
         @NonNull java.lang.String message,
         @NonNull java.lang.Throwable t)

logs a message and an exception in the specified log level

Parameters:

level - the Log Level

message - the message

t - the Exception

logf

void logf(@NonNull Logger.Level level,
          @NonNull java.lang.String pattern,
          java.lang.Object... args)

logs a formatted message in the specified log level.

For formatting String.format(String, Object...) is used. The following two method calls yield the same result, but the logf call allows the underlying implementation to prevent the formatting if the log level is disabled.
logf(Level.TRACE, "%5.3f", num);
log(Level.TRACE, String.format("%5.3", num));

Parameters:

level - the Log Level

pattern - the message format

args - the message arguments

See Also:

String.format(String, Object...)

logf

void logf(@NonNull Logger.Level level,
          @NonNull java.lang.String pattern,
          @NonNull java.lang.Throwable t,
          java.lang.Object... args)

logs a formatted message in the specified log level.

For formatting String.format(String, Object...) is used. The following two method calls yield the same result, but the logf call allows the underlying implementation to prevent the formatting if the log level is disabled.
logf(Level.TRACE, "%5.3f", num);
log(Level.TRACE, String.format("%5.3", num));

Parameters:

level - the Log Level

pattern - the message format

t - the exception

args - the message arguments

See Also:

String.format(String, Object...)

trace

void trace(@NonNull java.lang.String message)

convenience method for log(Level, String) with Logger.Level.TRACE.

Parameters:

message - the message

See Also:

log(Level, String)

debug

void debug(@NonNull java.lang.String message)

convenience method for log(Level, String) with Logger.Level.DEBUG.

Parameters:

message - the message

See Also:

log(Level, String)

info

void info(@NonNull java.lang.String message)

convenience method for log(Level, String) with Logger.Level.INFO.

Parameters:

message - the message

See Also:

log(Level, String)

warning

void warning(@NonNull java.lang.String message)

convenience method for log(Level, String) with Logger.Level.WARNING.

Parameters:

message - the message

See Also:

log(Level, String)

error

void error(@NonNull java.lang.String message)

convenience method for log(Level, String) with Logger.Level.ERROR.

Parameters:

message - the message

See Also:

log(Level, String)

fatal

void fatal(@NonNull java.lang.String message)

convenience method for log(Level, String) with Logger.Level.FATAL.

Parameters:

message - the message

See Also:

log(Level, String)

trace

void trace(@NonNull java.lang.String message,
           @NonNull java.lang.Throwable t)

convenience method for log(Level, String, Throwable) with Logger.Level.TRACE.

Parameters:

message - the message

t - the Exception

See Also:

log(Level, String, Throwable)

debug

void debug(@NonNull java.lang.String message,
           @NonNull java.lang.Throwable t)

convenience method for log(Level, String, Throwable) with Logger.Level.DEBUG.

Parameters:

message - the message

t - the Exception

See Also:

log(Level, String, Throwable)

info

void info(@NonNull java.lang.String message,
          @NonNull java.lang.Throwable t)

convenience method for log(Level, String, Throwable) with Logger.Level.INFO.

Parameters:

message - the message

t - the Exception

See Also:

log(Level, String, Throwable)

warning

void warning(@NonNull java.lang.String message,
             @NonNull java.lang.Throwable t)

convenience method for log(Level, String, Throwable) with Logger.Level.WARNING.

Parameters:

message - the message

t - the Exception

See Also:

log(Level, String, Throwable)

error

void error(@NonNull java.lang.String message,
           @NonNull java.lang.Throwable t)

convenience method for log(Level, String, Throwable) with Logger.Level.ERROR.

Parameters:

message - the message

t - the Exception

See Also:

log(Level, String, Throwable)

fatal

void fatal(@NonNull java.lang.String message,
           @NonNull java.lang.Throwable t)

convenience method for log(Level, String, Throwable) with Logger.Level.FATAL.

Parameters:

message - the message

t - the Exception

See Also:

log(Level, String, Throwable)

tracef

void tracef(@NonNull java.lang.String pattern,
            java.lang.Object... args)

convenience method for logf(Level, String, Object...) with Logger.Level.TRACE.

Parameters:

pattern - the message format

args - the message arguments

See Also:

logf(Level, String, Object...), String.format(String, Object...)

debugf

void debugf(@NonNull java.lang.String pattern,
            java.lang.Object... args)

convenience method for logf(Level, String, Object...) with Logger.Level.DEBUG.

Parameters:

pattern - the message format

args - the message arguments

See Also:

logf(Level, String, Object...), String.format(String, Object...)

infof

void infof(@NonNull java.lang.String pattern,
           java.lang.Object... args)

convenience method for logf(Level, String, Object...) with Logger.Level.INFO.

Parameters:

pattern - the message format

args - the message arguments

See Also:

logf(Level, String, Object...), String.format(String, Object...)

warningf

void warningf(@NonNull java.lang.String pattern,
              java.lang.Object... args)

convenience method for logf(Level, String, Object...) with Logger.Level.WARNING.

Parameters:

pattern - the message format

args - the message arguments

See Also:

logf(Level, String, Object...), String.format(String, Object...)

errorf

void errorf(@NonNull java.lang.String pattern,
            java.lang.Object... args)

convenience method for logf(Level, String, Object...) with Logger.Level.ERROR.

Parameters:

pattern - the message format

args - the message arguments

See Also:

logf(Level, String, Object...), String.format(String, Object...)

fatalf

void fatalf(@NonNull java.lang.String pattern,
            java.lang.Object... args)

convenience method for logf(Level, String, Object...) with Logger.Level.FATAL.

Parameters:

pattern - the message format

args - the message arguments

See Also:

logf(Level, String, Object...), String.format(String, Object...)

tracef

void tracef(@NonNull java.lang.String pattern,
            @NonNull java.lang.Throwable t,
            java.lang.Object... args)

convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.TRACE.

Parameters:

pattern - the message format

t - the Exception

args - the message arguments

See Also:

logf(Level, String, Throwable, Object...), String.format(String, Object...)

debugf

void debugf(@NonNull java.lang.String pattern,
            @NonNull java.lang.Throwable t,
            java.lang.Object... args)

convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.DEBUG.

Parameters:

pattern - the message format

t - the Exception

args - the message arguments

See Also:

logf(Level, String, Throwable, Object...), String.format(String, Object...)

infof

void infof(@NonNull java.lang.String pattern,
           @NonNull java.lang.Throwable t,
           java.lang.Object... args)

convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.INFO.

Parameters:

pattern - the message format

t - the Exception

args - the message arguments

See Also:

logf(Level, String, Throwable, Object...), String.format(String, Object...)

warningf

void warningf(@NonNull java.lang.String pattern,
              @NonNull java.lang.Throwable t,
              java.lang.Object... args)

convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.WARNING.

Parameters:

pattern - the message format

t - the Exception

args - the message arguments

See Also:

logf(Level, String, Throwable, Object...), String.format(String, Object...)

errorf

void errorf(@NonNull java.lang.String pattern,
            @NonNull java.lang.Throwable t,
            java.lang.Object... args)

convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.ERROR.

Parameters:

pattern - the message format

t - the Exception

args - the message arguments

See Also:

logf(Level, String, Throwable, Object...), String.format(String, Object...)

fatalf

void fatalf(@NonNull java.lang.String pattern,
            @NonNull java.lang.Throwable t,
            java.lang.Object... args)

convenience method for logf(Level, String, Throwable, Object...) with Logger.Level.FATAL.

Parameters:

pattern - the message format

t - the Exception

args - the message arguments

See Also:

logf(Level, String, Throwable, Object...), String.format(String, Object...)

isEnabled

boolean isEnabled(Logger.Level level)

checks whether the given log level is enabled for this logger.

Parameters:

level - the log level to check against

Returns:

true if the log level is enabled