hudson.tasks

Class Fingerprinter.FingerprintAction

java.lang.Object

hudson.tasks.Fingerprinter.FingerprintAction

All Implemented Interfaces:

Action, ModelObject, RunAction2

Enclosing class:

Fingerprinter

public static final class Fingerprinter.FingerprintAction
extends Object
implements RunAction2

Action for displaying fingerprints.

Constructor Summary

Constructors

Constructor and Description
FingerprintAction(AbstractBuild build, Map<String,String> record) Deprecated.
FingerprintAction(Run build, Map<String,String> record)

Method Summary

Modifier and Type	Method and Description
void	add(Map<String,String> moreRecords)
AbstractBuild	getBuild() Deprecated.
Map<AbstractProject,Integer>	getDependencies() Gets the dependency to other existing builds in a map.
Map<AbstractProject,Integer>	getDependencies(boolean includeMissing) Gets the dependency to other builds in a map.
String	getDisplayName() Gets the string to be displayed.
Map<String,Fingerprint>	getFingerprints() Map from file names of the fingerprinted file to its fingerprint record.
String	getIconFileName() Gets the name of the icon.
Map<String,String>	getRecords() Obtains the raw data.
Run	getRun()
String	getUrlName() Gets the URL path name.
void	onAttached(Run<?,?> r) Called when this action is added to a build.
void	onLoad(Run<?,?> r) Called after a build is loaded to which this action was previously attached.

Methods inherited from class java.lang.Object

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

Constructor Detail

FingerprintAction

public FingerprintAction(Run build,
                         Map<String,String> record)

FingerprintAction

@Deprecated
public FingerprintAction(AbstractBuild build,
                                     Map<String,String> record)

Deprecated.

Method Detail

add

public void add(Map<String,String> moreRecords)

getIconFileName

public String getIconFileName()

Description copied from interface: Action

Gets the name of the icon.

Specified by:

getIconFileName in interface Action

Returns:

If the icon name is prefixed with "symbol-", a Jenkins Symbol will be used.

If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.

Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.

See Also:

Jenkins Symbols, Functions.isAnonymous(), Functions.getIconFilePath(Action)

getDisplayName

public String getDisplayName()

Description copied from interface: Action

Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

Returns:

Can be null in case the action is hidden.

getUrlName

public String getUrlName()

Description copied from interface: Action

Gets the URL path name.

For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

This method should return a string that's unique among other Actions.

The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.

If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

Specified by:

getUrlName in interface Action

Returns:

null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().

See Also:

Functions.getActionUrl(String, Action)

getRun

public Run getRun()

getBuild

@Deprecated
public AbstractBuild getBuild()

Deprecated.

getRecords

public Map<String,String> getRecords()

Obtains the raw data.

onLoad

public void onLoad(Run<?,?> r)

Description copied from interface: RunAction2

Called after a build is loaded to which this action was previously attached.

Specified by:

onLoad in interface RunAction2

onAttached

public void onAttached(Run<?,?> r)

Description copied from interface: RunAction2

Called when this action is added to a build.

Specified by:

onAttached in interface RunAction2

getFingerprints

public Map<String,Fingerprint> getFingerprints()

Map from file names of the fingerprinted file to its fingerprint record.

getDependencies

public Map<AbstractProject,Integer> getDependencies()

Gets the dependency to other existing builds in a map.

getDependencies

public Map<AbstractProject,Integer> getDependencies(boolean includeMissing)

Gets the dependency to other builds in a map.

Parameters:

includeMissing - true if the original build should be included in the result, even if it doesn't exist

Since:

1.430