Class ExtensionConfigurator<T>
- java.lang.Object
-
- io.jenkins.plugins.casc.BaseConfigurator<T>
-
- io.jenkins.plugins.casc.impl.configurators.ExtensionConfigurator<T>
-
- All Implemented Interfaces:
Configurator<T>
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public class ExtensionConfigurator<T> extends BaseConfigurator<T>
A genericConfigurator
forExtension
singletons- 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 ExtensionConfigurator(Class<T> clazz)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CNode
describe(T instance, ConfigurationContext context)
Describe a component as a Configuration NodesCNode
to be exported as yaml.Class<T>
getTarget()
Target type this configurator can handle.protected T
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, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getName, getNames
-
-
-
-
Method Detail
-
getTarget
public Class<T> getTarget()
Description copied from interface:Configurator
Target type this configurator can handle.
-
instance
protected T instance(Mapping mapping, ConfigurationContext context) throws ConfiguratorException
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<T>
- 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)
- Throws:
ConfiguratorException
-
describe
@CheckForNull public CNode describe(T instance, ConfigurationContext context) throws Exception
Description copied from interface:Configurator
Describe a component as a Configuration NodesCNode
to be exported as yaml. Only export attributes which are not set to default value.- Throws:
Exception
-
-