Package org.jenkinsci.plugins.pipeline.modeldefinition.withscript

Class WithScriptDescriptor<T extends WithScriptDescribable<T>>

java.lang.Object

hudson.model.Descriptor<T>

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

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

DeclarativeAgentDescriptor, DeclarativeStageConditionalDescriptor

public abstract class WithScriptDescriptor<T extends WithScriptDescribable<T>>
extends Descriptor<T>

Descriptor for WithScriptDescribable.

Author:

Andrew Bayer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WithScriptDescriptor()

Method Summary

Modifier and Type	Method	Description
String	getName()	The name for this type.
String	getScriptClass()	The full package and class name for the WithScriptScript class corresponding to this.
T	newInstance()	Creates an instance of the corresponding WithScriptDescribable with no arguments.
T	newInstance(Map<String,Object> arguments)	Creates an instance of the corresponding WithScriptDescribable from the given arguments.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, 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, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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 Details

WithScriptDescriptor

protected WithScriptDescriptor()

Method Details

getName

@NonNull
public String getName()

The name for this type. Defaults to the first string in the Symbol on the class.

Returns:

The name.

getScriptClass

@NonNull
public String getScriptClass()

The full package and class name for the WithScriptScript class corresponding to this. Defaults to the WithScriptDescribable class name with "Script" appended to the end.

Returns:

The class name, defaulting to the WithScriptDescribable Descriptor.clazz class name with "Script" appended.

newInstance

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

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

Parameters:

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

Returns:

An instantiated WithScriptDescribable

Throws:

Exception - if there are issues instantiating

newInstance

public T newInstance()
              throws Exception

Creates an instance of the corresponding WithScriptDescribable with no arguments.

Returns:

An instantiated WithScriptDescribable

Throws:

Exception - if there are issues instantiating