Package org.jenkinsci.plugins.buildtriggerbadge.provider

Class BuildTriggerBadgeProvider

java.lang.Object

org.jenkinsci.plugins.buildtriggerbadge.provider.BuildTriggerBadgeProvider

All Implemented Interfaces:

ExtensionPoint

public abstract class BuildTriggerBadgeProvider
extends Object
implements ExtensionPoint

Extend this class to be able to define/override an association between a class and an icon. This will then add that icon as a badge in the build history side panel.

Note : if many providers are found, the first one matching a given cause class will be used.

Author:

Baptiste Mathus

See Also:

• BuildTriggerBadge screenshot as an example

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BuildTriggerBadgeProvider()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<BuildTriggerBadgeProvider>	all()
abstract String	provideIcon(Cause cause)	Should return the Jenkins Symbol or URL to the icon corresponding to the given cause.

Methods inherited from class java.lang.Object

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

Constructor Details

BuildTriggerBadgeProvider

public BuildTriggerBadgeProvider()

Method Details

provideIcon

@CheckForNull
public abstract String provideIcon(@NonNull
 Cause cause)

Should return the Jenkins Symbol or URL to the icon corresponding to the given cause.

Returns:

the symbol or URL of the icon for that cause, null if none provided.

all

public static ExtensionList<BuildTriggerBadgeProvider> all()