org.jenkinsci.plugins.pipeline.modeldefinition.when

Class DeclarativeStageConditionalDescriptor<S extends DeclarativeStageConditional<S>>

java.lang.Object

hudson.model.Descriptor<T>

org.jenkinsci.plugins.pipeline.modeldefinition.withscript.WithScriptDescriptor<S>

org.jenkinsci.plugins.pipeline.modeldefinition.when.DeclarativeStageConditionalDescriptor<S>

All Implemented Interfaces:

hudson.model.Saveable

public abstract class DeclarativeStageConditionalDescriptor<S extends DeclarativeStageConditional<S>>
extends WithScriptDescriptor<S>

Base descriptor for DeclarativeStageConditional.

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
DeclarativeStageConditionalDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.ExtensionList<DeclarativeStageConditionalDescriptor>	all() Get all DeclarativeStageConditionalDescriptors.
static List<String>	allNames()
static DeclarativeStageConditionalDescriptor	byName(String name) Get the descriptor for a given name or null if not found.
int	getAllowedChildrenCount() How many nested conditions are allowed.
static Map<String,org.jenkinsci.plugins.structs.describable.DescribableModel>	getDescribableModels() Get a map of name-to-DescribableModel of all known/registered descriptors.
static DeclarativeStageConditional<?>	instanceFromDescriptor(DeclarativeStageConditionalDescriptor<?> descriptor, Map<String,Object> arguments) For a given descriptor and map of arguments, return an instance using those arguments.

Methods inherited from class org.jenkinsci.plugins.pipeline.modeldefinition.withscript.WithScriptDescriptor

getName, getScriptClass, newInstance, newInstance

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

DeclarativeStageConditionalDescriptor

public DeclarativeStageConditionalDescriptor()

Method Detail

getAllowedChildrenCount

public int getAllowedChildrenCount()

How many nested conditions are allowed. -1 for unlimited, 0 for none, anything greater than 0 for requiring exactly that many nested conditions.

all

public static hudson.ExtensionList<DeclarativeStageConditionalDescriptor> all()

Get all DeclarativeStageConditionalDescriptors.

Returns:

a list of all DeclarativeStageConditionalDescriptors registered.`

allNames

public static List<String> allNames()

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 DeclarativeStageConditionalDescriptor 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.

instanceFromDescriptor

@Nonnull
public static DeclarativeStageConditional<?> instanceFromDescriptor(@Nonnull
                                                            DeclarativeStageConditionalDescriptor<?> 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