Package io.jenkins.plugins.util

Class LogHandler

java.lang.Object

io.jenkins.plugins.util.LogHandler

public class LogHandler
extends Object

Handles logging of issues log and error messages to a TaskListener instance.

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor	Description
LogHandler(TaskListener listener, String name)	Creates a new LogHandler.
LogHandler(TaskListener listener, String name, edu.hm.hafner.util.FilteredLog logger)	Creates a new LogHandler.

Method Summary

Modifier and Type	Method	Description
void	log(edu.hm.hafner.util.FilteredLog logger)	Log all info and error messages that are stored in the set of issues.
void	log(String format, Object... args)	Logs the specified message.
void	logErrorMessages(List<String> errorMessages)	Logs the specified error messages.
void	logInfoMessages(List<String> infoMessages)	Logs the specified information messages.
void	setQuiet(boolean quiet)

Methods inherited from class java.lang.Object

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

Constructor Details

LogHandler

public LogHandler(TaskListener listener,
 String name)

Creates a new LogHandler.

Parameters:

listener - the task listener that will print all log messages

name - the name of the logger

LogHandler

public LogHandler(TaskListener listener,
 String name,
 edu.hm.hafner.util.FilteredLog logger)

Creates a new LogHandler.

Parameters:

listener - the task listener that will print all log messages

name - the name of the logger

logger - the logger that contains the actual log messages

Method Details

log

public void log(edu.hm.hafner.util.FilteredLog logger)

Log all info and error messages that are stored in the set of issues. Note that subsequent calls to this method will only log messages that have not yet been logged.

Parameters:

logger - the logger with the collected messages

log

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

Logs the specified message.

Parameters:

format - A format string

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

logErrorMessages

public void logErrorMessages(List<String> errorMessages)

Logs the specified error messages.

Parameters:

errorMessages - the error messages to log

logInfoMessages

public void logInfoMessages(List<String> infoMessages)

Logs the specified information messages.

Parameters:

infoMessages - the information messages to log

setQuiet

public void setQuiet(boolean quiet)