hudson.scm.listtagsparameter
Class ListSubversionTagsParameterDefinition

java.lang.Object
  hudson.model.ParameterDefinition
      hudson.scm.listtagsparameter.ListSubversionTagsParameterDefinition

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.ParameterDefinition>, Serializable, Comparable<ListSubversionTagsParameterDefinition>

public class ListSubversionTagsParameterDefinition
extends hudson.model.ParameterDefinition
implements Comparable<ListSubversionTagsParameterDefinition>

Defines a new ParameterDefinition to be displayed at the top of the configuration page of AbstractProjects.

When used, this parameter will request the user to select a Subversion tag at build-time by displaying a drop-down list. See ListSubversionTagsParameterValue.

Author:

Romain Seguy (http://openromain.blogspot.com)

See Also:

Serialized Form

Nested Class Summary

static class

ListSubversionTagsParameterDefinition.DescriptorImpl

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

hudson.model.ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

ListSubversionTagsParameterDefinition(String name, String tagsDir, String tagsFilter, String defaultValue, String maxTags, boolean reverseByDate, boolean reverseByName, String uuid)

Method Summary

int	compareTo(ListSubversionTagsParameterDefinition pd)
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req)
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
hudson.model.ParameterValue	getDefaultParameterValue()
String	getDefaultValue()
ListSubversionTagsParameterDefinition.DescriptorImpl	getDescriptor()
String	getMaxTags()
List<String>	getTags() Returns a list of Subversion dirs to be displayed in ListSubversionTagsParameterDefinition/index.jelly.
String	getTagsDir()
String	getTagsFilter()
boolean	isReverseByDate()
boolean	isReverseByName()
protected void	removeParentDir(List<String> dirs) Removes the parent directory (that is, the tags directory) from a list of directories.

Methods inherited from class hudson.model.ParameterDefinition

all, copyWithDefaultValue, createValue, getDescription, getName, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

ListSubversionTagsParameterDefinition

@DataBoundConstructor
public ListSubversionTagsParameterDefinition(String name,
                                                                  String tagsDir,
                                                                  String tagsFilter,
                                                                  String defaultValue,
                                                                  String maxTags,
                                                                  boolean reverseByDate,
                                                                  boolean reverseByName,
                                                                  String uuid)

Method Detail

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req)

Specified by:

createValue in class hudson.model.ParameterDefinition

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req,
                                               net.sf.json.JSONObject formData)

Specified by:

createValue in class hudson.model.ParameterDefinition

getDefaultParameterValue

public hudson.model.ParameterValue getDefaultParameterValue()

Overrides:

getDefaultParameterValue in class hudson.model.ParameterDefinition

getDescriptor

public ListSubversionTagsParameterDefinition.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.model.ParameterDefinition>

Overrides:

getDescriptor in class hudson.model.ParameterDefinition

getTags

public List<String> getTags()

Returns a list of Subversion dirs to be displayed in ListSubversionTagsParameterDefinition/index.jelly.

This method plainly reuses settings that must have been previously defined when configuring the Subversion SCM.

This method never returns null. In case an error happens, the returned list contains an error message surrounded by < and >.

getTagsDir

public String getTagsDir()

getTagsFilter

public String getTagsFilter()

isReverseByDate

public boolean isReverseByDate()

isReverseByName

public boolean isReverseByName()

getDefaultValue

public String getDefaultValue()

getMaxTags

public String getMaxTags()

removeParentDir

protected void removeParentDir(List<String> dirs)

Removes the parent directory (that is, the tags directory) from a list of directories.

compareTo

public int compareTo(ListSubversionTagsParameterDefinition pd)

Specified by:

compareTo in interface Comparable<ListSubversionTagsParameterDefinition>