Package hudson.maven

Class MavenReporterDescriptor

java.lang.Object

hudson.model.Descriptor<MavenReporter>

hudson.maven.MavenReporterDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

BuildInfoRecorder.DescriptorImpl, MavenArtifactArchiver.DescriptorImpl, MavenFingerprinter.DescriptorImpl, MavenJavadocArchiver.DescriptorImpl, MavenMailer.DescriptorImpl, MavenSiteArchiver.DescriptorImpl, MavenTestJavadocArchiver.DescriptorImpl, ReportCollector.DescriptorImpl, SurefireArchiver.DescriptorImpl

public abstract class MavenReporterDescriptor
extends Descriptor<MavenReporter>

Descriptor for MavenReporter.

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	MavenReporterDescriptor()	Infers the type of the corresponding Describable from the outer class.
protected	MavenReporterDescriptor(Class<? extends MavenReporter> clazz)

Method Summary

Modifier and Type	Method	Description
static Collection<MavenReporterDescriptor>	all()	Lists all the currently registered instances of MavenReporterDescriptor.
final boolean	hasConfigScreen()	Returns true if this descriptor has config.jelly.
MavenReporter	newAutoInstance(MavenModule module)	Returns an instance used for automatic MavenReporter activation.
MavenReporter	newInstance(org.kohsuke.stapler.StaplerRequest req)	Deprecated.
String	reportedFilePattern()	File patterns this reporter might create when running inside the Maven JVM.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, 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, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, 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

MavenReporterDescriptor

protected MavenReporterDescriptor(Class<? extends MavenReporter> clazz)

MavenReporterDescriptor

protected MavenReporterDescriptor()

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 MavenReporter newAutoInstance(MavenModule module)

Returns an instance used for automatic MavenReporter activation.

Some MavenReporters, such as MavenArtifactArchiver, can work just with the configuration in POM and don't need any additional Hudson 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 MavenReporters should return a valid instance from this method. Such instance will then participate into the build and receive event callbacks.

newInstance

@Deprecated
public MavenReporter newInstance(org.kohsuke.stapler.StaplerRequest req)
                          throws Descriptor.FormException

Deprecated.

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

Overrides:

newInstance in class Descriptor<MavenReporter>

Throws:

Descriptor.FormException

hasConfigScreen

public final boolean hasConfigScreen()

Returns true if this descriptor has config.jelly.

all

public static Collection<MavenReporterDescriptor> all()

Lists all the currently registered instances of MavenReporterDescriptor.

reportedFilePattern

@CheckForNull
public String reportedFilePattern()

File patterns this reporter might create when running inside the Maven JVM. Applies to usages from MavenReporter.postBuild(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.model.BuildListener) and similar callbacks of MavenBuildProxy.getRootDir(), MavenBuildProxy.getProjectRootDir(), and MavenBuildProxy.getModuleSetRootDir(). (But not MavenBuildProxy.getArtifactsDir(), which should not be used anyway.)

Returns:

an Ant-style file pattern of files we expect to copy, or null if not applicable (default)