Package org.jvnet.hudson.plugins.groovypostbuild

Class GroovyPostbuildRecorder.BadgeManager

java.lang.Object

org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder.BadgeManager

Enclosing class:

GroovyPostbuildRecorder

public static class GroovyPostbuildRecorder.BadgeManager
extends Object

Constructor Summary

Constructors

Constructor	Description
BadgeManager(Run<?,?> build, TaskListener listener, Result scriptFailureResult)

Method Summary

Modifier and Type	Method	Description
void	addBadge(String icon, String text)
void	addBadge(String icon, String text, String link)
void	addErrorBadge(String text)
void	addHtmlBadge(String html)
void	addInfoBadge(String text)
void	addShortText(String text)
void	addShortText(String text, String color, String background, String border, String borderColor)
void	addWarningBadge(String text)
void	buildAborted()
void	buildFailure()
boolean	buildIsA(Class<? extends AbstractBuild<?,?>> buildClass)	Test whether the current build is specified type.
void	buildNotBuilt()
void	buildScriptFailed(Exception e)
void	buildSuccess()
void	buildUnstable()
boolean	contains(File f, String regexp)	Deprecated.
boolean	contains(File f, Charset charset, String regexp)	Deprecated.
com.jenkinsci.plugins.badge.action.BadgeSummaryAction	createSummary(String icon)
Run<?,?>	getBuild()
String	getEnvVariable(String key)
EnvVars	getEnvVars()
Hudson	getHudson()	Deprecated. use $getJenkins()
Jenkins	getJenkins()
TaskListener	getListener()
Matcher	getLogMatcher(String regexp)
Matcher	getMatcher(File f, String regexp)	Deprecated.
Matcher	getMatcher(File f, Charset charset, String regexp)	Deprecated.
Matcher	getMatcher(Reader r, String regexp)
String	getResult()
boolean	logContains(String regexp)
void	println(String string)
void	removeBadge(int index)	removeBadge(int) is removeBadgeAction(int) under a historic misnomer name: despite the name, it indexes into badges and summaries together.
void	removeBadgeAction(int index)	Removes the AbstractBadgeAction at the given index from the build.
void	removeBadgeActions()	Removes every AbstractBadgeAction object from the build, which includes both actual badges seen in the build list column, and the summaries seen on the build page. If you want only one of those Action types removed, use the variants constrained to it instead: removeBadgesOnly() for badges only, or removeSummaries() for summaries only. Removal in this context means that the Action would no longer be linked to the specified build.
void	removeBadgeOnly(int index)	For details, see removeBadgeActions().
void	removeBadges()	removeBadges() is removeBadgeActions() under a historic misnomer name: despite the name, it removes both badges and summaries.
void	removeBadgesOnly()	For details, see removeBadgeActions().
void	removeSummaries()	For details, see removeBadgeActions().
void	removeSummary(int index)	For details, see removeBadgeActions().
void	setBuild(Run<?,?> build)
boolean	setBuildNumber(int buildNumber)

Methods inherited from class java.lang.Object

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

Constructor Details

BadgeManager

public BadgeManager(Run<?,?> build,
 TaskListener listener,
 Result scriptFailureResult)

Method Details

getEnvVars

public EnvVars getEnvVars()

println

public void println(String string)

getEnvVariable

public String getEnvVariable(String key)
                      throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getHudson

@Deprecated
public Hudson getHudson()

Deprecated.

use $getJenkins()

Returns:

the jenkins insance

getJenkins

public Jenkins getJenkins()

getBuild

public Run<?,?> getBuild()

setBuild

public void setBuild(Run<?,?> build)

setBuildNumber

public boolean setBuildNumber(int buildNumber)

getListener

public TaskListener getListener()

addShortText

public void addShortText(String text)

addShortText

public void addShortText(String text,
 String color,
 String background,
 String border,
 String borderColor)

addBadge

public void addBadge(String icon,
 String text)

addBadge

public void addBadge(String icon,
 String text,
 String link)

addInfoBadge

public void addInfoBadge(String text)

addWarningBadge

public void addWarningBadge(String text)

addErrorBadge

public void addErrorBadge(String text)

addHtmlBadge

public void addHtmlBadge(String html)

getResult

public String getResult()

removeBadgeActions

public void removeBadgeActions()

Removes every AbstractBadgeAction object from the build, which includes both actual badges seen in the build list column, and the summaries seen on the build page.
If you want only one of those Action types removed, use the variants constrained to it instead: removeBadgesOnly() for badges only, or removeSummaries() for summaries only.
Removal in this context means that the Action would no longer be linked to the specified build. An object in the pipeline (if someone gets the reference, e.g. via new Badge Plugin API) may still exist until it is no longer used and gets garbage-collected. Maybe someone can re-add such an Action object to same or different build before it evaporates, though.

See Also:

• removeBadgeAction(int)
• removeBadges()
• removeBadge(int)
• removeBadgesOnly()
• removeBadgeOnly(int)
• removeSummaries()
• removeSummary(int)

removeBadges

public void removeBadges()

removeBadges() is removeBadgeActions() under a historic misnomer name: despite the name, it removes both badges and summaries. This method is kept for backward compatibility and simply delegates to removeBadgeActions().
Note: at a future major version, removeBadges() is scheduled to be narrowed to mean what removeBadgesOnly() means today, i.e. removing badges only, not summaries. Callers who want today's behavior (removing every AbstractBadgeAction, badges and summaries alike) should move to removeBadgeActions() instead.

See Also:

• removeBadgeActions()
• removeBadge(int)
• removeBadgesOnly()
• removeBadgeOnly(int)
• removeSummaries()
• removeSummary(int)

removeBadgeAction

public void removeBadgeAction(int index)

Removes the AbstractBadgeAction at the given index from the build. The index is into the combined list of every AbstractBadgeAction, i.e. both actual badges seen in the build list column, and the summaries seen on the build page. See removeBadgeActions() for what that list contains and what removal means.
If index is out of range, an error is written to the listener and nothing is removed.

See Also:

• removeBadgeActions()
• removeBadges()
• removeBadge(int)
• removeBadgesOnly()
• removeBadgeOnly(int)
• removeSummaries()
• removeSummary(int)

removeBadge

public void removeBadge(int index)

removeBadge(int) is removeBadgeAction(int) under a historic misnomer name: despite the name, it indexes into badges and summaries together. This method is kept for backward compatibility and simply delegates to removeBadgeAction(int).
Note: at a future major version, removeBadge(int) is scheduled to be narrowed to mean what removeBadgeOnly(int) means today, i.e. indexing into badges only, not summaries. Callers who want today's behavior (indexing into every AbstractBadgeAction, badges and summaries alike) should move to removeBadgeAction(int) instead.

See Also:

• removeBadgeAction(int)
• removeBadges()
• removeBadgesOnly()
• removeBadgeOnly(int)
• removeSummaries()
• removeSummary(int)

removeBadgesOnly

public void removeBadgesOnly()

For details, see removeBadgeActions().

See Also:

• removeBadgeActions()
• removeBadgeAction(int)
• removeBadges()
• removeBadge(int)
• removeBadgeOnly(int)
• removeSummaries()
• removeSummary(int)

removeBadgeOnly

public void removeBadgeOnly(int index)

For details, see removeBadgeActions().

See Also:

• removeBadgeActions()
• removeBadgeAction(int)
• removeBadges()
• removeBadge(int)
• removeBadgesOnly()
• removeSummaries()
• removeSummary(int)

createSummary

public com.jenkinsci.plugins.badge.action.BadgeSummaryAction createSummary(String icon)

removeSummaries

public void removeSummaries()

For details, see removeBadgeActions().

See Also:

• removeBadgeActions()
• removeBadgeAction(int)
• removeBadges()
• removeBadge(int)
• removeBadgesOnly()
• removeBadgeOnly(int)
• removeSummary(int)

removeSummary

public void removeSummary(int index)

For details, see removeBadgeActions().

See Also:

• removeBadgeActions()
• removeBadgeAction(int)
• removeBadges()
• removeBadge(int)
• removeBadgesOnly()
• removeBadgeOnly(int)
• removeSummaries()

buildUnstable

public void buildUnstable()

buildFailure

public void buildFailure()

buildSuccess

public void buildSuccess()

buildAborted

public void buildAborted()

buildNotBuilt

public void buildNotBuilt()

buildScriptFailed

public void buildScriptFailed(Exception e)

logContains

public boolean logContains(String regexp)

contains

@Deprecated
public boolean contains(File f,
 String regexp)

Deprecated.

contains

@Deprecated
public boolean contains(File f,
 Charset charset,
 String regexp)

Deprecated.

getLogMatcher

public Matcher getLogMatcher(String regexp)

getMatcher

@Deprecated
public Matcher getMatcher(File f,
 String regexp)

Deprecated.

getMatcher

public Matcher getMatcher(Reader r,
 String regexp)

getMatcher

@Deprecated
public Matcher getMatcher(File f,
 Charset charset,
 String regexp)

Deprecated.

buildIsA

public boolean buildIsA(Class<? extends AbstractBuild<?,?>> buildClass)

Test whether the current build is specified type.

Parameters:

buildClass -

Returns:

true if the current build is an instance of buildClass