Package com.sonyericsson.rebuild

Class RebuildParameterProvider

java.lang.Object

com.sonyericsson.rebuild.RebuildParameterProvider

All Implemented Interfaces:

ExtensionPoint

public abstract class RebuildParameterProvider
extends Object
implements ExtensionPoint

Extension point to provide views to show parameters in rebuild page. If you want your custom ParameterValue to work with rebuild plugin, do as followings:

1. Add a dependency to rebuild plugin to your pom.xml. You should specify <optional>true</optional> to have your plugin work without rebuild plugin.
2. Define a class implementing RebuildParameterProvider.
3. Annotate the class with Extension. You should specify option=true in Extension annotation to have your plugin work without rebuild plugin.
4. Override getRebuildPage(ParameterValue). Don't forget to return null for parameter values other than your custom ParameterValue. There are two recommended ways to set values to RebuildParameterPage:

   Recommended way to set values

   	Recommended 1	Recommended 2
   clazz	your custom ParameterValue	the class implementing RebuildParameterProvider
   page	a file in the resource directory of your custom ParameterValue	a file in the resource directory of the class implementing RebuildParameterProvider

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
RebuildParameterProvider()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<RebuildParameterProvider>	all()
abstract RebuildParameterPage	getRebuildPage(ParameterValue value)	Provide a view for specified ParameterValue.

Methods inherited from class java.lang.Object

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

Constructor Details

RebuildParameterProvider

public RebuildParameterProvider()

Method Details

getRebuildPage

public abstract RebuildParameterPage getRebuildPage(ParameterValue value)

Provide a view for specified ParameterValue. Return null if cannot handle specified ParameterValue.

Parameters:

value - a value to be shown in a rebuild page.

Returns:

page for the parameter value. null for parameter values cannot be handled.

all

public static ExtensionList<RebuildParameterProvider> all()

Returns:

all RebuildParameterProvider registered to Jenkins.