Package hudson.ivy

Class IvyReporterDescriptor

java.lang.Object

hudson.model.Descriptor<IvyReporter>

hudson.ivy.IvyReporterDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

public abstract class IvyReporterDescriptor
extends Descriptor<IvyReporter>

Descriptor for IvyReporter.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IvyReporterDescriptor()	Infers the type of the corresponding Describable from the outer class.
protected	IvyReporterDescriptor(Class<? extends IvyReporter> clazz)

Method Summary

Modifier and Type	Method	Description
static Collection<IvyReporterDescriptor>	all()	Lists all the currently registered instances of IvyReporterDescriptor.
final boolean	hasConfigScreen()	Returns true if this descriptor has config.jelly.
IvyReporter	newAutoInstance(IvyModule module)	Returns an instance used for automatic IvyReporter activation.
IvyReporter	newInstance(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData)	If the reporter has no configuration screen, this method can safely return null, which is the default implementation.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Details

IvyReporterDescriptor

protected IvyReporterDescriptor(Class<? extends IvyReporter> clazz)

IvyReporterDescriptor

protected IvyReporterDescriptor()

Infers the type of the corresponding Describable from the outer class. This version works when you follow the common convention, where a descriptor is written as the static nested class of the describable class.

Since:

1.278

Method Details

newAutoInstance

public IvyReporter newAutoInstance(IvyModule module)

Returns an instance used for automatic IvyReporter activation.

Some IvyReporters, such as IvyArtifactArchiver, can work just with the configuration in the Ivy descriptor and don't need any additional Jenkins configuration. They also don't need any explicit enabling/disabling as they can activate themselves by listening to the callback from the build (for example javadoc archiver can do the work in response to the execution of the javadoc target.)

Those IvyReporters should return a valid instance from this method. Such instance will then participate into the build and receive event callbacks.

newInstance

public IvyReporter newInstance(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject formData)
                        throws Descriptor.FormException

If the reporter has no configuration screen, this method can safely return null, which is the default implementation.

Overrides:

newInstance in class Descriptor<IvyReporter>

Throws:

Descriptor.FormException

hasConfigScreen

public final boolean hasConfigScreen()

Returns true if this descriptor has config.jelly.

all

public static Collection<IvyReporterDescriptor> all()

Lists all the currently registered instances of IvyReporterDescriptor.