Package org.jenkinsci.plugins.pipeline.maven.util

Class TaskListenerTraceWrapper

java.lang.Object

org.jenkinsci.plugins.pipeline.maven.util.TaskListenerTraceWrapper

public class TaskListenerTraceWrapper
extends Object

This class provides methods which wrap the original TaskListener. All trace* methods check if traceability is enabled before doing anything.

Constructor Summary

Constructors

Constructor	Description
TaskListenerTraceWrapper(TaskListener taskListener, boolean traceability)	Wrap the given TaskListener.

Method Summary

Modifier and Type	Method	Description
PrintStream	format(String format, Object... args)	Wraps TaskListener.getLogger() format calls.
PrintStream	formatTrace(String format, Object... args)	Wraps TaskListener.getLogger() format calls.
void	println(CharSequence s)	Wraps TaskListener.getLogger() println calls.
void	trace(Object o)	Prints the given Object to the underlying TaskListener if traceability is enabled.
void	trace(String s)	Prints the given String to the underlying TaskListener if traceability is enabled.
void	traceHyperlink(String url, String text)	Wraps the TaskListener.hyperlink(String, String) function.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskListenerTraceWrapper

public TaskListenerTraceWrapper(TaskListener taskListener,
                                boolean traceability)

Wrap the given TaskListener.

Parameters:

taskListener - the wrapped listener

traceability - the boolean flag for traceability

Method Detail

trace

public void trace(String s)

Prints the given String to the underlying TaskListener if traceability is enabled.

Parameters:

s - the string to print

trace

public void trace(Object o)

Prints the given Object to the underlying TaskListener if traceability is enabled.

Parameters:

o - the object to print

traceHyperlink

public void traceHyperlink(String url,
                           String text)
                    throws IOException

Wraps the TaskListener.hyperlink(String, String) function. If traceability is disabled do nothing.

Parameters:

url - TaskListener.hyperlink(java.lang.String, java.lang.String)

text - TaskListener.hyperlink(java.lang.String, java.lang.String)

Throws:

IOException

println

public void println(CharSequence s)

Wraps TaskListener.getLogger() println calls.

Parameters:

s - The CharSequence to be printed.

format

public PrintStream format(String format,
                          Object... args)

Wraps TaskListener.getLogger() format calls.

Parameters:

format - PrintStream.format(java.lang.String, java.lang.Object...)

args - PrintStream.format(java.lang.String, java.lang.Object...)

Returns:

PrintStream.format(java.lang.String, java.lang.Object...)

formatTrace

public PrintStream formatTrace(String format,
                               Object... args)

Wraps TaskListener.getLogger() format calls. If traceability is disabled do nothing.

Parameters:

format - PrintStream.format(java.lang.String, java.lang.Object...)

args - PrintStream.format(java.lang.String, java.lang.Object...)

Returns:

PrintStream.format(java.lang.String, java.lang.Object...)