Package hudson.scm.listtagsparameter

Class ListSubversionTagsParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.scm.listtagsparameter.ListSubversionTagsParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class ListSubversionTagsParameterDefinition
extends ParameterDefinition

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

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

Nested Classes

Modifier and Type	Class	Description
static class	ListSubversionTagsParameterDefinition.DescriptorImpl

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

ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor	Description
ListSubversionTagsParameterDefinition(String name, String tagsDir, String tagsFilter, String defaultValue, String maxTags, boolean reverseByDate, boolean reverseByName, String uuid)	Deprecated.
ListSubversionTagsParameterDefinition(String name, String tagsDir, String tagsFilter, String defaultValue, String maxTags, boolean reverseByDate, boolean reverseByName, String uuid, String credentialsId)	Deprecated.
ListSubversionTagsParameterDefinition(String name, String tagsDir, String credentialsId, String tagsFilter, String defaultValue, String maxTags, boolean reverseByDate, boolean reverseByName)

Method Summary

Modifier and Type	Method	Description
ParameterValue	createValue(CLICommand command, String value)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
String	getCredentialsId()
ParameterValue	getDefaultParameterValue()
String	getDefaultValue()
ListSubversionTagsParameterDefinition.DescriptorImpl	getDescriptor()
String	getMaxTags()
List<String>	getTags(Job context)	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, equals, getDescription, getFormattedDescription, getName, getType, hashCode, isValid, setDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

ListSubversionTagsParameterDefinition

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

Deprecated.

ListSubversionTagsParameterDefinition

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

Deprecated.

ListSubversionTagsParameterDefinition

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

Method Detail

createValue

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

Specified by:

createValue in class ParameterDefinition

createValue

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

Specified by:

createValue in class ParameterDefinition

createValue

public ParameterValue createValue(CLICommand command,
                                  String value)
                           throws IOException,
                                  InterruptedException

Overrides:

createValue in class ParameterDefinition

Throws:

IOException

InterruptedException

getDefaultParameterValue

public ParameterValue getDefaultParameterValue()

Overrides:

getDefaultParameterValue in class ParameterDefinition

getDescriptor

public ListSubversionTagsParameterDefinition.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<ParameterDefinition>

Overrides:

getDescriptor in class ParameterDefinition

getTags

@NonNull
public List<String> getTags(@Nullable
                            Job context)

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 prefixed by !.

getTagsDir

public String getTagsDir()

getCredentialsId

public String getCredentialsId()

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.