Package hudson.maven
Class MavenReporterDescriptor
- java.lang.Object
-
- hudson.model.Descriptor<MavenReporter>
-
- hudson.maven.MavenReporterDescriptor
-
- 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
forMavenReporter
.- 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
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
MavenReporterDescriptor()
Infers the type of the correspondingDescribable
from the outer class.protected
MavenReporterDescriptor(Class<? extends MavenReporter> clazz)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Collection<MavenReporterDescriptor>
all()
Lists all the currently registered instances ofMavenReporterDescriptor
.boolean
hasConfigScreen()
Returns true if this descriptor hasconfig.jelly
.MavenReporter
newAutoInstance(MavenModule module)
Returns an instance used for automaticMavenReporter
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
-
-
-
-
Constructor Detail
-
MavenReporterDescriptor
protected MavenReporterDescriptor(Class<? extends MavenReporter> clazz)
-
MavenReporterDescriptor
protected MavenReporterDescriptor()
Infers the type of the correspondingDescribable
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 Detail
-
newAutoInstance
public MavenReporter newAutoInstance(MavenModule module)
Returns an instance used for automaticMavenReporter
activation.Some
MavenReporter
s, such asMavenArtifactArchiver
, 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
MavenReporter
s 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.Ifthe reporter has no configuration screen
, this method can safely return null, which is the default implementation.- Overrides:
newInstance
in classDescriptor<MavenReporter>
- Throws:
Descriptor.FormException
-
hasConfigScreen
public final boolean hasConfigScreen()
Returns true if this descriptor hasconfig.jelly
.
-
all
public static Collection<MavenReporterDescriptor> all()
Lists all the currently registered instances ofMavenReporterDescriptor
.
-
reportedFilePattern
@CheckForNull public String reportedFilePattern()
File patterns this reporter might create when running inside the Maven JVM. Applies to usages fromMavenReporter.postBuild(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.model.BuildListener)
and similar callbacks ofMavenBuildProxy.getRootDir()
,MavenBuildProxy.getProjectRootDir()
, andMavenBuildProxy.getModuleSetRootDir()
. (But notMavenBuildProxy.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)
-
-