org.jenkinsci.plugins.darcs
Class DarcsScmDescriptor

java.lang.Object
  hudson.model.Descriptor<SCM>
      hudson.scm.SCMDescriptor<DarcsScm>
          org.jenkinsci.plugins.darcs.DarcsScmDescriptor

All Implemented Interfaces:

Saveable

@Extension
public class DarcsScmDescriptor
extends SCMDescriptor<DarcsScm>

Inner class of the SCM descriptor. Contains the global configuration options as fields.

Author:

Sven Strittmatter

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

private String	darcsExe The executable.
private static String	DEFAULT_EXE Default name of the Darcs binary.
private static String	DISPLAY_NAME String displayed in the Jenkins front end.
private static Logger	LOGGER Logging facility.

Fields inherited from class hudson.scm.SCMDescriptor

generation, repositoryBrowser

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

DarcsScmDescriptor()
Dedicated constructor.

Method Summary

boolean	configure(StaplerRequest req, net.sf.json.JSONObject formData)
FormValidation	doDarcsExeCheck(String value) Validated the given executable string if it is a valid Darcs executable.
String	getDarcsExe() Returns the executable.
String	getDisplayName() Returns the display name.
void	load() Own implementation of XML configuration loading to inject Jenkins.XSTREAM2 for unmarshalling.
SCM	newInstance(StaplerRequest req, net.sf.json.JSONObject formData)

Methods inherited from class hudson.scm.SCMDescriptor

getBrowserDescriptors, isApplicable, isBrowserReusable

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getT, getViewPage, isInstance, isSubTypeOf, 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

Field Detail

LOGGER

private static final Logger LOGGER

Logging facility.

DISPLAY_NAME

private static final String DISPLAY_NAME

String displayed in the Jenkins front end.

See Also:

Constant Field Values

DEFAULT_EXE

private static final String DEFAULT_EXE

Default name of the Darcs binary.

See Also:

Constant Field Values

darcsExe

private String darcsExe

The executable. May be null.

Constructor Detail

DarcsScmDescriptor

public DarcsScmDescriptor()

Dedicated constructor.

Method Detail

load

public void load()

Own implementation of XML configuration loading to inject Jenkins.XSTREAM2 for unmarshalling. TODO Remove this, if it possible to inject XStream into parent implementation. Since 1.494 Dexcriptor#getConfigFile() is not private anymore. override load() and call getConfigFile().getXStream().addCompatibilityAlias() public void load() { getConfigFile().getXStream().addCompatibilityAlias("org.jenkinsci.plugins.darcs.DarcsScm$DescriptorImpl", DarcsScmDescriptor.class); super.load(); }

Overrides:

load in class SCMDescriptor<DarcsScm>

getDisplayName

public String getDisplayName()

Returns the display name.

Specified by:

getDisplayName in class Descriptor<SCM>

Returns:

display name string

getDarcsExe

public String getDarcsExe()

Returns the executable.

Returns:

if darcsExe is null DEFAULT_EXE will be returned

newInstance

public SCM newInstance(StaplerRequest req,
                       net.sf.json.JSONObject formData)
                throws Descriptor.FormException

Overrides:

newInstance in class Descriptor<SCM>

Throws:

Descriptor.FormException

configure

public boolean configure(StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws Descriptor.FormException

Overrides:

configure in class Descriptor<SCM>

Throws:

Descriptor.FormException

doDarcsExeCheck

public FormValidation doDarcsExeCheck(@QueryParameter
                                      String value)

Validated the given executable string if it is a valid Darcs executable.

Parameters:

value - string from the plugin configuration field

Returns:

validation object which indicates validation state