hudson.tasks
Class ArtifactArchiver.DescriptorImpl

java.lang.Object
  extended by hudson.model.Descriptor<T>
      extended by hudson.tasks.BuildStepDescriptor<Publisher>
          extended by hudson.tasks.ArtifactArchiver.DescriptorImpl
All Implemented Interfaces:
Saveable
Enclosing class:
ArtifactArchiver

@Extension
public static class ArtifactArchiver.DescriptorImpl
extends BuildStepDescriptor<Publisher>


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
ArtifactArchiver.DescriptorImpl()
           
 
Method Summary
 FormValidation doCheckArtifacts(AbstractProject project, String value)
          Performs on-the-fly validation on the file mask wildcard.
 String getDisplayName()
          Human readable name of this kind of configurable object.
 boolean isApplicable(Class<? extends AbstractProject> jobType)
          Returns true if this task is applicable to the given project.
 ArtifactArchiver newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
          Creates a configured instance from the submitted form.
 
Methods inherited from class hudson.tasks.BuildStepDescriptor
filter
 
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, 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 Detail

ArtifactArchiver.DescriptorImpl

public ArtifactArchiver.DescriptorImpl()
Method Detail

getDisplayName

public String getDisplayName()
Description copied from class: Descriptor
Human readable name of this kind of configurable object.

Specified by:
getDisplayName in class Descriptor<Publisher>

doCheckArtifacts

public FormValidation doCheckArtifacts(@AncestorInPath
                                       AbstractProject project,
                                       @QueryParameter
                                       String value)
                                throws IOException
Performs on-the-fly validation on the file mask wildcard.

Throws:
IOException

newInstance

public ArtifactArchiver newInstance(org.kohsuke.stapler.StaplerRequest req,
                                    net.sf.json.JSONObject formData)
                             throws Descriptor.FormException
Description copied from class: Descriptor
Creates a configured instance from the submitted form.

Hudson only invokes this method when the user wants an instance of T. So there's no need to check that in the implementation.

Starting 1.206, the default implementation of this method does the following:

 req.bindJSON(clazz,formData);
 

... which performs the databinding on the constructor of Descriptor.clazz.

For some types of Describable, such as ListViewColumn, this method can be invoked with null request object for historical reason. Such design is considered broken, but due to the compatibility reasons we cannot fix it. Because of this, the default implementation gracefully handles null request, but the contract of the method still is "request is always non-null." Extension points that need to define the "default instance" semantics should define a descriptor subtype and add the no-arg newInstance method.

Overrides:
newInstance in class Descriptor<Publisher>
Parameters:
req - Always non-null (see note above.) This object includes represents the entire submission.
formData - The JSON object that captures the configuration data for this Descriptor. See http://wiki.jenkins-ci.org/display/JENKINS/Structured+Form+Submission Always non-null.
Throws:
Descriptor.FormException - Signals a problem in the submitted form.

isApplicable

public boolean isApplicable(Class<? extends AbstractProject> jobType)
Description copied from class: BuildStepDescriptor
Returns true if this task is applicable to the given project.

Specified by:
isApplicable in class BuildStepDescriptor<Publisher>
Returns:
true to allow user to configure this post-promotion task for the given project.
See Also:
AbstractProject.AbstractProjectDescriptor.isApplicable(Descriptor)


Copyright © 2004-2013. All Rights Reserved.