com.google.jenkins.plugins.deploy

Class BuildStepDetailsProvider<T extends hudson.tasks.BuildStep>

java.lang.Object

com.google.jenkins.plugins.deploy.BuildStepDetailsProvider<T>

Type Parameters:

T - the supported build step type.

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

BuildStepDetailsProvider.MavenBuildStepDetailsProvider, BuildStepDetailsProvider.ShellBuildStepDetailsProvider, GoogleCloudManagerDeployer.DetailsProvider

public abstract class BuildStepDetailsProvider<T extends hudson.tasks.BuildStep>
extends Object
implements hudson.ExtensionPoint

An extension to provide additional details for a given BuildStep. Subclasses will need to overwrite getDetails(BuildStep) for the build step type they supported.

To provide details for a new build step, add a class as

 
    @Extension
    @DetailFor(value = AwesomeBuildStep.class)
   public static class AwesomeBuildStepDetailsProvider
       extends BuildStepDetailsProvider <AwesomeBuildStep> {
      @Override
     public String getBuildStepDetails(AwesomeBuildStep myAwesomeBuildStep) {
       return myAwesomeBuildStep.getDetails(); // or other logic here
     }
   }
 
 

See examples in BuildStepDetailsProvider.MavenBuildStepDetailsProvider and BuildStepDetailsProvider.ShellBuildStepDetailsProvider below.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildStepDetailsProvider.MavenBuildStepDetailsProvider BuildStepDetailsProvider for Maven.
static class	BuildStepDetailsProvider.ShellBuildStepDetailsProvider BuildStepDetailsProvider for Shell.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
BuildStepDetailsProvider()

Method Summary

Modifier and Type	Method and Description
static Collection<BuildStepDetailsProvider>	all()
protected static String	defaultName(hudson.tasks.BuildStep bs)
abstract String	getDetails(T bs)
String	getFullCmd(T bs) This provides a hook by which detail provider may provide different full command line details as getDetails() method.
String	getName(T bs) This provides a hook by which detail providers may decide to not use the display name of the plugin as the waypoint name.
protected boolean	isApplicable(hudson.tasks.BuildStep buildStep)
static String	resolveDetails(hudson.tasks.BuildStep bs)
static com.google.common.collect.ImmutableList<String>	resolveFullCmd(hudson.tasks.BuildStep bs)
static String	resolveName(hudson.tasks.BuildStep bs)

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildStepDetailsProvider

public BuildStepDetailsProvider()

Method Detail

resolveDetails

@Nullable
public static String resolveDetails(hudson.tasks.BuildStep bs)

Parameters:

bs - A given BuildStep.

Returns:

the details obtained from the BuildStep, null if there is not an extension to obtain details.

resolveFullCmd

@Nullable
public static com.google.common.collect.ImmutableList<String> resolveFullCmd(hudson.tasks.BuildStep bs)

Parameters:

bs - A given BuildStep.

Returns:

the full tokenized command line including the program name.

resolveName

@Nullable
public static String resolveName(hudson.tasks.BuildStep bs)

Parameters:

bs - a BuildStep.

Returns:

the display name of the BuildStep, if it is a Describable, otherwise null.

defaultName

protected static String defaultName(hudson.tasks.BuildStep bs)

all

public static Collection<BuildStepDetailsProvider> all()

Returns:

all the extension for this ExtensionPoint BuildStepDetailsProvider.

getDetails

public abstract String getDetails(T bs)

Parameters:

bs - A given BuildStep.

Returns:

the details of the build step.

getFullCmd

public String getFullCmd(T bs)

This provides a hook by which detail provider may provide different full command line details as getDetails() method.

Parameters:

bs - A given BuildStep.

Returns:

the full command line including the program name.

getName

public String getName(T bs)

This provides a hook by which detail providers may decide to not use the display name of the plugin as the waypoint name.

isApplicable

protected boolean isApplicable(hudson.tasks.BuildStep buildStep)

Parameters:

buildStep - a given BuildStep.

Returns:

whether the BuildStep is supported by this extension.