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>
-
- Direct Known Subclasses:
GlobalStageConditionalDescriptor
public abstract class DeclarativeStageConditionalDescriptor<S extends DeclarativeStageConditional<S>> extends WithScriptDescriptor<S>
Base descriptor forDeclarativeStageConditional
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.jenkinsci.plugins.pipeline.modeldefinition.withscript.WithScriptDescriptor
WithScriptDescriptor.WithScriptAllowlist
-
Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
-
-
Field Summary
-
Fields inherited from class hudson.model.Descriptor
clazz
-
-
Constructor Summary
Constructors Constructor Description DeclarativeStageConditionalDescriptor()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static List<DeclarativeStageConditionalDescriptor>
all()
Get allDeclarativeStageConditionalDescriptor
s.static List<DeclarativeStageConditionalDescriptor>
allInvisible()
static List<String>
allNames()
static DeclarativeStageConditionalDescriptor
byName(String name)
Get the descriptor for a given name or null if not found.static List<DeclarativeStageConditionalDescriptor>
forGenerator()
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.boolean
inDirectiveGenerator()
Whether this conditional can be rendered in the Directive Generator.boolean
isInvisible()
Whether this conditional is an invisible global conditional.abstract org.codehaus.groovy.ast.expr.Expression
transformToRuntimeAST(org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTWhenContent original)
-
Methods inherited from class org.jenkinsci.plugins.pipeline.modeldefinition.withscript.WithScriptDescriptor
getName, getScriptClass, newInstance, newInstance
-
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, bindJSON, 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, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
-
-
-
-
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.
-
inDirectiveGenerator
public boolean inDirectiveGenerator()
Whether this conditional can be rendered in the Directive Generator. Defaults to whether there's a config page - which we determine by checking to see ifDescriptor.getConfigPage()
returns something other than its default "config.jelly". It will if there's an actual config.jelly or config.groovy either for this class or an ancestor.
-
isInvisible
public boolean isInvisible()
Whether this conditional is an invisible global conditional. Defaults to false.
-
transformToRuntimeAST
public abstract org.codehaus.groovy.ast.expr.Expression transformToRuntimeAST(@CheckForNull org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTWhenContent original)
-
all
public static List<DeclarativeStageConditionalDescriptor> all()
Get allDeclarativeStageConditionalDescriptor
s.- Returns:
- a list of all
DeclarativeStageConditionalDescriptor
s registered, except for invisible global conditionals.
-
forGenerator
public static List<DeclarativeStageConditionalDescriptor> forGenerator()
-
allInvisible
public static List<DeclarativeStageConditionalDescriptor> allInvisible()
-
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-
DescribableModel
s
-
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.
-
-