com.seitenbau.jenkins.plugins.dynamicparameter.config
Enum DynamicParameterConfiguration

java.lang.Object
  java.lang.Enum<DynamicParameterConfiguration>
      com.seitenbau.jenkins.plugins.dynamicparameter.config.DynamicParameterConfiguration

All Implemented Interfaces:

Serializable, Comparable<DynamicParameterConfiguration>

public enum DynamicParameterConfiguration
extends Enum<DynamicParameterConfiguration>

Dynamic parameter configuration options.

Enum Constant Summary

INSTANCE
Single class instance.

Method Summary

String	getBaseDirectory() Get the base directory.
File	getBaseDirectoryFile() Get the base directory as instance of File.
void	setBaseDirectory(String newBaseDirectory) Set a new base directory.
static DynamicParameterConfiguration	valueOf(String name) Returns the enum constant of this type with the specified name.
static DynamicParameterConfiguration[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final DynamicParameterConfiguration INSTANCE

Single class instance.

Method Detail

values

public static DynamicParameterConfiguration[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DynamicParameterConfiguration c : DynamicParameterConfiguration.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DynamicParameterConfiguration valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getBaseDirectoryFile

public File getBaseDirectoryFile()

Get the base directory as instance of File.

Returns:

base directory

getBaseDirectory

public String getBaseDirectory()
                        throws IOException

Get the base directory.

Returns:

canonical path to the base directory

Throws:

IOException - if path can not be resolved

setBaseDirectory

public void setBaseDirectory(String newBaseDirectory)
                      throws IOException

Set a new base directory.

Parameters:

newBaseDirectory - new directory path

Throws:

IOException - if configuration cannot be saved