Class DescriptorConfigurator
- java.lang.Object
-
- io.jenkins.plugins.casc.BaseConfigurator<Descriptor>
-
- io.jenkins.plugins.casc.impl.configurators.DescriptorConfigurator
-
- All Implemented Interfaces:
Configurator<Descriptor>
,RootElementConfigurator<Descriptor>
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public class DescriptorConfigurator extends BaseConfigurator<Descriptor> implements RootElementConfigurator<Descriptor>
Define a Configurator for a Descriptor- Author:
- Nicolas De Loof
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class io.jenkins.plugins.casc.BaseConfigurator
BaseConfigurator.TypePair
-
-
Constructor Summary
Constructors Constructor Description DescriptorConfigurator(Descriptor descriptor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Get a configurator name.List<String>
getNames()
Get all possible configurator namesClass<Descriptor>
getTarget()
Target type this configurator can handle.Descriptor
getTargetComponent(ConfigurationContext context)
Retrieve the target component managed by this RootElementConfiguratorprotected Descriptor
instance(Mapping mapping, ConfigurationContext context)
Build or identify the target component this configurator has to handle based on the provided configuration node.-
Methods inherited from class io.jenkins.plugins.casc.BaseConfigurator
check, compare, configure, configure, createAttribute, describe, equals, exclusions, handleUnknown, hashCode
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.jenkins.plugins.casc.Configurator
canConfigure, check, configure, describe, describe, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI
-
Methods inherited from interface io.jenkins.plugins.casc.RootElementConfigurator
isRootElement
-
-
-
-
Constructor Detail
-
DescriptorConfigurator
public DescriptorConfigurator(Descriptor descriptor)
-
-
Method Detail
-
getName
@NonNull public String getName()
Description copied from interface:Configurator
Get a configurator name. This should return the default name for the configurator, used for exporting yaml seeConfigurator.getNames()
for all possible names which will be considered when configuring.- Specified by:
getName
in interfaceConfigurator<Descriptor>
- Returns:
- short name for this component when used in a configuration.yaml file
-
getNames
@NonNull public List<String> getNames()
Description copied from interface:Configurator
Get all possible configurator names- Specified by:
getNames
in interfaceConfigurator<Descriptor>
- Returns:
- a list of all possible short names for this component when used in a configuration.yaml file
-
getTarget
public Class<Descriptor> getTarget()
Description copied from interface:Configurator
Target type this configurator can handle.- Specified by:
getTarget
in interfaceConfigurator<Descriptor>
-
getTargetComponent
public Descriptor getTargetComponent(ConfigurationContext context)
Description copied from interface:RootElementConfigurator
Retrieve the target component managed by this RootElementConfigurator- Specified by:
getTargetComponent
in interfaceRootElementConfigurator<Descriptor>
- Returns:
-
instance
protected Descriptor instance(Mapping mapping, ConfigurationContext context)
Description copied from class:BaseConfigurator
Build or identify the target component this configurator has to handle based on the provided configuration node.- Specified by:
instance
in classBaseConfigurator<Descriptor>
- Parameters:
mapping
- configuration for target component. Implementation may consume some entries to create a fresh new instance.- Returns:
- instance to be configured, but not yet fully configured, see
BaseConfigurator.configure(Mapping, Object, boolean, ConfigurationContext)
-
-