org.rvpf.base.logger

Class StringLogger

Object

StringLogger

@Immutable
public final class StringLogger
extends Object

String logger.

Used by scripts to avoid the 'deprecated' warning for format strings.

Method Summary

Modifier and Type	Method and Description
void	debug(String format, Object... params) Logs a debug message.
void	debug(Supplier<Message> messageSupplier) Logs a debug message.
void	debug(Throwable cause, String format, Object... params) Logs a debug message.
void	error(String format, Object... params) Logs an error message.
void	error(Throwable cause, String format, Object... params) Logs an error message.
void	fatal(String format, Object... params) Logs a fatal message.
void	fatal(Throwable cause, String format, Object... params) Logs a fatal message.
static StringLogger	getInstance(Class<?> ownerClass) Gets a logger instance.
static StringLogger	getInstance(Logger log4jLogger) Gets a logger instance.
static StringLogger	getInstance(String name) Gets a logger instance.
Logger	getLogger() Gets the logger.
Logger.LogLevel	getLogLevel() Gets the log level.
void	info(String format, Object... params) Logs an info message.
void	info(Supplier<Message> messageSupplier) Logs an info message.
void	info(Throwable cause, String format, Object... params) Logs an info message.
boolean	isDebugEnabled() Asks if the debug level is enabled.
boolean	isEnabledFor(Logger.LogLevel logLevel) Asks if a log level is enabled.
boolean	isInfoEnabled() Asks if the info level is enabled.
boolean	isTraceEnabled() Asks if the trace level is enabled.
void	trace(String format, Object... params) Logs a trace message.
void	trace(Supplier<Message> messageSupplier) Logs a trace message.
void	trace(Throwable cause, String format, Object... params) Logs a trace message.
void	warn(String format, Object... params) Logs a warning message.
void	warn(Throwable cause, String format, Object... params) Logs a warning message.

Methods inherited from class Object

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

Method Detail

getInstance

@Nonnull
 @CheckReturnValue
public static StringLogger getInstance(@Nonnull
                                                                     Class<?> ownerClass)

Gets a logger instance.

Parameters:

ownerClass - The class of the logger's owner.

Returns:

The logger instance.

getInstance

@Nonnull
 @CheckReturnValue
public static StringLogger getInstance(@Nonnull
                                                                     Logger log4jLogger)

Gets a logger instance.

This is used by scripts to supply their Log4j logger in calls to RVPF.

Parameters:

log4jLogger - A log4j logger.

Returns:

The logger instance.

getInstance

@Nonnull
 @CheckReturnValue
public static StringLogger getInstance(@Nonnull
                                                                     String name)

Gets a logger instance.

Parameters:

name - The logger's name.

Returns:

The logger instance.

debug

public void debug(@Nonnull
                  Supplier<Message> messageSupplier)

Logs a debug message.

Parameters:

messageSupplier - A message supplier.

debug

public void debug(@Nonnull
                  String format,
                  @Nonnull
                  Object... params)

Logs a debug message.

Parameters:

format - The message format.

params - The message parameters.

debug

public void debug(@Nonnull
                  Throwable cause,
                  @Nonnull
                  String format,
                  @Nonnull
                  Object... params)

Logs a debug message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

error

public void error(@Nonnull
                  String format,
                  @Nonnull
                  Object... params)

Logs an error message.

Parameters:

format - The message format.

params - The message parameters.

error

public void error(@Nonnull
                  Throwable cause,
                  @Nonnull
                  String format,
                  @Nonnull
                  Object... params)

Logs an error message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

fatal

public void fatal(@Nonnull
                  String format,
                  @Nonnull
                  Object... params)

Logs a fatal message.

Parameters:

format - The message format.

params - The message parameters.

fatal

public void fatal(@Nonnull
                  Throwable cause,
                  @Nonnull
                  String format,
                  @Nonnull
                  Object... params)

Logs a fatal message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

getLogLevel

@Nonnull
 @CheckReturnValue
public Logger.LogLevel getLogLevel()

Gets the log level.

Returns:

The log level.

getLogger

@Nonnull
 @CheckReturnValue
public Logger getLogger()

Gets the logger.

Returns:

The logger.

info

public void info(@Nonnull
                 Supplier<Message> messageSupplier)

Logs an info message.

Parameters:

messageSupplier - A message supplier.

info

public void info(@Nonnull
                 String format,
                 @Nonnull
                 Object... params)

Logs an info message.

Parameters:

format - The message format.

params - The message parameters.

info

public void info(@Nonnull
                 Throwable cause,
                 @Nonnull
                 String format,
                 @Nonnull
                 Object... params)

Logs an info message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

isDebugEnabled

@CheckReturnValue
public boolean isDebugEnabled()

Asks if the debug level is enabled.

Returns:

True if enabled.

isEnabledFor

@CheckReturnValue
public boolean isEnabledFor(Logger.LogLevel logLevel)

Asks if a log level is enabled.

Parameters:

logLevel - The log level.

Returns:

True if enabled.

isInfoEnabled

@CheckReturnValue
public boolean isInfoEnabled()

Asks if the info level is enabled.

Returns:

True if enabled.

isTraceEnabled

@CheckReturnValue
public boolean isTraceEnabled()

Asks if the trace level is enabled.

Returns:

True if enabled.

trace

public void trace(@Nonnull
                  Supplier<Message> messageSupplier)

Logs a trace message.

Parameters:

messageSupplier - A message supplier.

trace

public void trace(@Nonnull
                  String format,
                  @Nonnull
                  Object... params)

Logs a trace message.

Parameters:

format - The message format.

params - The message parameters.

trace

public void trace(@Nonnull
                  Throwable cause,
                  @Nonnull
                  String format,
                  @Nonnull
                  Object... params)

Logs a trace message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

warn

public void warn(@Nonnull
                 String format,
                 @Nonnull
                 Object... params)

Logs a warning message.

Parameters:

format - The message format.

params - The message parameters.

warn

public void warn(@Nonnull
                 Throwable cause,
                 @Nonnull
                 String format,
                 @Nonnull
                 Object... params)

Logs a warning message.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.