hudson.maven
Class MavenModuleSet.DescriptorImpl

java.lang.Object
  extended by hudson.model.Descriptor<TopLevelItem>
      extended by hudson.model.TopLevelItemDescriptor
          extended by hudson.model.AbstractProject.AbstractProjectDescriptor
              extended by hudson.maven.MavenModuleSet.DescriptorImpl
All Implemented Interfaces:
Saveable
Enclosing class:
MavenModuleSet

public static final class MavenModuleSet.DescriptorImpl
extends AbstractProject.AbstractProjectDescriptor


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
MavenModuleSet.DescriptorImpl()
           
 
Method Summary
 boolean configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject o)
          Invoked when the global configuration page is submitted.
 String getDisplayName()
          Human readable name of this kind of configurable object.
 String getGlobalMavenOpts()
           
 List<GlobalSettingsProviderDescriptor> getGlobalSettingsProviders()
           
 String getHelpFile(String fieldName)
          Returns the path to the help screen HTML for the given field.
 LocalRepositoryLocator getLocalRepository()
           
 Maven.DescriptorImpl getMavenDescriptor()
           
 Map<String,Integer> getMavenValidationLevels()
           
 List<SettingsProviderDescriptor> getSettingsProviders()
           
 boolean isApplicable(Descriptor descriptor)
          AbstractProject subtypes can override this method to veto some Descriptors from showing up on their configuration screen.
 MavenModuleSet newInstance(ItemGroup parent, String name)
          Creates a new TopLevelItem for the specified parent.
 void setGlobalMavenOpts(String globalMavenOpts)
           
 void setLocalRepository(LocalRepositoryLocator localRepository)
           
 
Methods inherited from class hudson.model.AbstractProject.AbstractProjectDescriptor
doAutoCompleteAssignedLabelString, doAutoCompleteUpstreamProjects, doCheckAssignedLabelString, doCheckCustomWorkspace, getApplicableSCMCheckoutStrategyDescriptors
 
Methods inherited from class hudson.model.TopLevelItemDescriptor
all, newInstance, newInstance, testInstance
 
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, 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

MavenModuleSet.DescriptorImpl

public MavenModuleSet.DescriptorImpl()
Method Detail

getHelpFile

public String getHelpFile(String fieldName)
Description copied from class: Descriptor
Returns the path to the help screen HTML for the given field.

The help files are assumed to be at "help/FIELDNAME.html" with possible locale variations.

Overrides:
getHelpFile in class Descriptor<TopLevelItem>

getSettingsProviders

public List<SettingsProviderDescriptor> getSettingsProviders()

getGlobalSettingsProviders

public List<GlobalSettingsProviderDescriptor> getGlobalSettingsProviders()

getGlobalMavenOpts

public String getGlobalMavenOpts()

setGlobalMavenOpts

public void setGlobalMavenOpts(String globalMavenOpts)

getLocalRepository

public LocalRepositoryLocator getLocalRepository()
Returns:
never null.

setLocalRepository

public void setLocalRepository(LocalRepositoryLocator localRepository)

getDisplayName

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

Used as the caption when the user chooses what job type to create. The descriptor implementation also needs to have newJobDetail.jelly script, which will be used to render the text below the caption that explains the job type.

Specified by:
getDisplayName in class TopLevelItemDescriptor

newInstance

public MavenModuleSet newInstance(ItemGroup parent,
                                  String name)
Description copied from class: TopLevelItemDescriptor
Creates a new TopLevelItem for the specified parent.

Specified by:
newInstance in class TopLevelItemDescriptor

getMavenDescriptor

public Maven.DescriptorImpl getMavenDescriptor()

getMavenValidationLevels

public Map<String,Integer> getMavenValidationLevels()
Returns:
Since:
1.394

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject o)
Description copied from class: Descriptor
Invoked when the global configuration page is submitted. Can be overriden to store descriptor-specific information.

Overrides:
configure in class Descriptor<TopLevelItem>
o - The JSON object that captures the configuration data for this Descriptor. See http://wiki.jenkins-ci.org/display/JENKINS/Structured+Form+Submission
Returns:
false to keep the client in the same config page.

isApplicable

public boolean isApplicable(Descriptor descriptor)
Description copied from class: AbstractProject.AbstractProjectDescriptor
AbstractProject subtypes can override this method to veto some Descriptors from showing up on their configuration screen. This is often useful when you are building a workflow/company specific project type, where you want to limit the number of choices given to the users.

Some Descriptors define their own schemes for controlling applicability (such as BuildStepDescriptor.isApplicable(Class)), This method works like AND in conjunction with them; Both this method and that method need to return true in order for a given Descriptor to show up for the given Project.

The default implementation returns true for everything.

Overrides:
isApplicable in class AbstractProject.AbstractProjectDescriptor
See Also:
BuildStepDescriptor.isApplicable(Class), BuildWrapperDescriptor.isApplicable(AbstractProject), TriggerDescriptor.isApplicable(Item)


Copyright © 2004-2013. All Rights Reserved.