org.jenkinsci.plugins.pipeline.modeldefinition.options

Class DeclarativeOptionDescriptor

java.lang.Object

hudson.model.Descriptor<DeclarativeOption>

org.jenkinsci.plugins.pipeline.modeldefinition.options.DeclarativeOptionDescriptor

All Implemented Interfaces:

hudson.model.Saveable

public abstract class DeclarativeOptionDescriptor
extends hudson.model.Descriptor<DeclarativeOption>

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DeclarativeOptionDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.ExtensionList<DeclarativeOptionDescriptor>	all() Get all DeclarativeOptionDescriptors.
static DeclarativeOptionDescriptor	byName(String name) Get the descriptor for a given name or null if not found.
static Map<String,org.jenkinsci.plugins.structs.describable.DescribableModel>	getDescribableModels() Get a map of name-to-DescribableModel of all known/registered descriptors.
String	getName()
static DeclarativeOption	instanceFromDescriptor(DeclarativeOptionDescriptor descriptor, Map<String,Object> arguments) For a given descriptor and map of arguments, return an instance using those arguments.
static DeclarativeOption	instanceFromName(String name, Map<String,Object> arguments) For a given name and map of arguments, find the corresponding descriptor and return an instance using those arguments.
DeclarativeOption	newInstance(Map<String,Object> arguments) Creates an instance of the corresponding DeclarativeOption from the given arguments.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, 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

DeclarativeOptionDescriptor

public DeclarativeOptionDescriptor()

Method Detail

getName

@Nonnull
public String getName()

all

public static hudson.ExtensionList<DeclarativeOptionDescriptor> all()

Get all DeclarativeOptionDescriptors.

Returns:

a list of all DeclarativeOptionDescriptors registered.`

getDescribableModels

public static Map<String,org.jenkinsci.plugins.structs.describable.DescribableModel> getDescribableModels()

Get a map of name-to-DescribableModel of all known/registered descriptors.

Returns:

A map of name-to-DescribableModels

byName

@Nullable
public static DeclarativeOptionDescriptor byName(@Nonnull
                                          String name)

Get the descriptor for a given name or null if not found.

Parameters:

name - The name for the descriptor to look up

Returns:

The corresponding descriptor or null if not found.

instanceFromName

@Nullable
public static DeclarativeOption instanceFromName(@Nonnull
                                          String name,
                                          Map<String,Object> arguments)
                                          throws Exception

For a given name and map of arguments, find the corresponding descriptor and return an instance using those arguments.

Parameters:

name - The name of the descriptor

arguments - A map of arguments

Returns:

The instantiated DeclarativeOption instance, or null if the name isn't found.

Throws:

Exception

newInstance

public DeclarativeOption newInstance(Map<String,Object> arguments)
                              throws Exception

Creates an instance of the corresponding DeclarativeOption from the given arguments.

Parameters:

arguments - A map of strings/objects to be passed to the constructor.

Returns:

An instantiated DeclarativeOption

Throws:

Exception

instanceFromDescriptor

@Nonnull
public static DeclarativeOption instanceFromDescriptor(@Nonnull
                                               DeclarativeOptionDescriptor descriptor,
                                               Map<String,Object> arguments)
                                                throws Exception

For a given descriptor and map of arguments, return an instance using those arguments.

Parameters:

descriptor - The descriptor instance

arguments - A map of arguments

Returns:

The instantiated DeclarativeOption instance.

Throws:

Exception