io.jenkins.plugins.forensics.util

Class FilteredLog

java.lang.Object

io.jenkins.plugins.forensics.util.FilteredLog

All Implemented Interfaces:

Serializable

public class FilteredLog
extends Object
implements Serializable

Provides a log file with a limited number of error messages. If the number of errors exceeds this limit, then subsequent error messages will be skipped.

Author:

Ullrich Hafner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilteredLog(String title) Creates a new FilteredLog for a Report.
FilteredLog(String title, int maxLines) Creates a new FilteredLog for a Report.

Method Summary

Modifier and Type	Method and Description
List<String>	getErrorMessages() Returns the error messages that have been reported since the creation of this set of issues.
List<String>	getInfoMessages() Returns the info messages that have been reported since the creation of this set of issues.
void	logError(String format, Object... args) Logs the specified error message.
void	logException(Exception exception, String format, Object... args) Logs the specified exception.
void	logInfo(String format, Object... args) Logs the specified information message.
void	logSummary() Writes a summary message to the reports' error log that denotes the total number of errors that have been reported.
int	size() Returns the total number of errors that have been reported.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredLog

public FilteredLog(String title)

Creates a new FilteredLog for a Report. Number of printed errors: DEFAULT_MAX_LINES.

Parameters:

title - the title of the error messages

FilteredLog

public FilteredLog(String title,
                   int maxLines)

Creates a new FilteredLog for a Report.

Parameters:

title - the title of the error messages

maxLines - the maximum number of lines to log

Method Detail

logInfo

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

Logs the specified information message. Use this method to log any useful information when composing this log.

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.

logError

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

Logs the specified error message. Use this method to log any error when composing this log.

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.

logException

@FormatMethod
public void logException(Exception exception,
                                       String format,
                                       Object... args)

Logs the specified exception. Use this method to log any exception when composing this log.

Parameters:

exception - the exception to log

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.

size

public int size()

Returns the total number of errors that have been reported.

Returns:

the total number of errors

logSummary

public void logSummary()

Writes a summary message to the reports' error log that denotes the total number of errors that have been reported.

getInfoMessages

public List<String> getInfoMessages()

Returns the info messages that have been reported since the creation of this set of issues.

Returns:

the info messages

getErrorMessages

public List<String> getErrorMessages()

Returns the error messages that have been reported since the creation of this set of issues.

Returns:

the error messages