jenkins.util

Class BuildListenerAdapter

java.lang.Object

jenkins.util.BuildListenerAdapter

All Implemented Interfaces:

BuildListener, TaskListener, Serializable

public final class BuildListenerAdapter
extends Object
implements BuildListener

Wraps a TaskListener as a BuildListener for compatibility with APIs which historically expected the latter. Does not support BuildListener.started(java.util.List<hudson.model.Cause>) or BuildListener.finished(hudson.model.Result).

Since:

1.577

See Also:

Serialized Form

Field Summary

Fields inherited from interface hudson.model.TaskListener

NULL

Constructor Summary

Constructors

Constructor and Description
BuildListenerAdapter(TaskListener delegate)

Method Summary

Modifier and Type	Method and Description
void	annotate(ConsoleNote ann) Annotates the current position in the output log by using the given annotation.
PrintWriter	error(String msg) An error in the build.
PrintWriter	error(String format, Object... args) Formatter#format(String, Object[]) version of TaskListener.error(String).
PrintWriter	fatalError(String msg) A fatal error in the build.
PrintWriter	fatalError(String format, Object... args) Formatter#format(String, Object[]) version of TaskListener.fatalError(String).
void	finished(Result result) Called when a build is finished.
PrintStream	getLogger() This writer will receive the output of the build
void	hyperlink(String url, String text) Places a HyperlinkNote on the given text.
void	started(List<Cause> causes) Called when a build is started.
static BuildListener	wrap(TaskListener l)

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildListenerAdapter

public BuildListenerAdapter(TaskListener delegate)

Method Detail

started

public void started(List<Cause> causes)

Description copied from interface: BuildListener

Called when a build is started.

Specified by:

started in interface BuildListener

Parameters:

causes - Causes that started a build. See Run.getCauses().

finished

public void finished(Result result)

Description copied from interface: BuildListener

Called when a build is finished.

Specified by:

finished in interface BuildListener

getLogger

public PrintStream getLogger()

Description copied from interface: TaskListener

This writer will receive the output of the build

Specified by:

getLogger in interface TaskListener

Returns:

must be non-null.

annotate

public void annotate(ConsoleNote ann)
              throws IOException

Description copied from interface: TaskListener

Annotates the current position in the output log by using the given annotation. If the implementation doesn't support annotated output log, this method might be no-op.

Specified by:

annotate in interface TaskListener

Throws:

IOException

hyperlink

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

Description copied from interface: TaskListener

Places a HyperlinkNote on the given text.

Specified by:

hyperlink in interface TaskListener

Parameters:

url - If this starts with '/', it's interpreted as a path within the context path.

Throws:

IOException

error

public PrintWriter error(String msg)

Description copied from interface: TaskListener

An error in the build.

Specified by:

error in interface TaskListener

Returns:

A writer to receive details of the error. Not null.

error

public PrintWriter error(String format,
                         Object... args)

Description copied from interface: TaskListener

Formatter#format(String, Object[]) version of TaskListener.error(String).

Specified by:

error in interface TaskListener

fatalError

public PrintWriter fatalError(String msg)

Description copied from interface: TaskListener

A fatal error in the build.

Specified by:

fatalError in interface TaskListener

Returns:

A writer to receive details of the error. Not null.

fatalError

public PrintWriter fatalError(String format,
                              Object... args)

Description copied from interface: TaskListener

Formatter#format(String, Object[]) version of TaskListener.fatalError(String).

Specified by:

fatalError in interface TaskListener

wrap

public static BuildListener wrap(TaskListener l)