de.berg.systeme.jenkins.wix

Enum ToolsetLogger

java.lang.Object

java.lang.Enum<ToolsetLogger>

de.berg.systeme.jenkins.wix.ToolsetLogger

All Implemented Interfaces:

Serializable, Comparable<ToolsetLogger>

public enum ToolsetLogger
extends Enum<ToolsetLogger>

internal logger which uses PrintStream from Jenkins Listener. You have to initialize logger with init().

Author:

Bjoern.Berg

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton approach

Method Summary

Modifier and Type	Method and Description
void	debug(String msg) logs a simple debug message.
void	debug(String format, Object... args) logs a formatted debug message.
void	enableDebugLogging(boolean debug)
void	init(PrintStream stream) initializes logger with print stream.
void	init(PrintStream stream, boolean debugEnabled) initializes logger with print stream and enables or disables logging of debug messages.
void	log(String msg) logs a simple message.
void	log(String format, Object... args) logs a formatted message.
static ToolsetLogger	valueOf(String name) Returns the enum constant of this type with the specified name.
static ToolsetLogger[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ToolsetLogger INSTANCE

Singleton approach

Method Detail

values

public static ToolsetLogger[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ToolsetLogger c : ToolsetLogger.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ToolsetLogger valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

init

public void init(PrintStream stream)

initializes logger with print stream. Use Jenkins Listener.getLogger().

Parameters:

stream - print stream of Listener.getLogger().

init

public void init(PrintStream stream,
                 boolean debugEnabled)

initializes logger with print stream and enables or disables logging of debug messages. Use Listener.getLogger() for initializing print stream.

Parameters:

stream - print stream of Listener.getLogger().

debugEnabled - true enables debug logging.

enableDebugLogging

public void enableDebugLogging(boolean debug)

log

public void log(String msg)

logs a simple message.

Parameters:

msg - message string.

log

public void log(String format,
                Object... args)

logs a formatted message.

Parameters:

format - the message containing formatting symbols.

args - arguments to replace formatting symbols.

debug

public void debug(String msg)

logs a simple debug message.

Parameters:

msg - debug message string.

debug

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

logs a formatted debug message.

Parameters:

format - message with format specifiers as placeholders.

args - replacements as comma-separated list for format specifiers.