Package io.jenkins.plugins.casc

Interface ItemConfigurator<T extends TopLevelItem>

All Superinterfaces:

Configurator<T>

All Known Implementing Classes:

FreestyleItemConfigurator

public interface ItemConfigurator<T extends TopLevelItem>
extends Configurator<T>

Method Summary

Modifier and Type	Method	Description
T	configure(String name, CNode config, ConfigurationContext context)
String	getName()	Get a configurator name.
Class<T>	getTarget()	Target type this configurator can handle.

Methods inherited from interface io.jenkins.plugins.casc.Configurator

canConfigure, check, configure, describe, describe, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getNames

Method Details

getName

@NonNull
String getName()

Description copied from interface: Configurator

Get a configurator name. This should return the default name for the configurator, used for exporting yaml see Configurator.getNames() for all possible names which will be considered when configuring.

Specified by:

getName in interface Configurator<T extends TopLevelItem>

Returns:

short name for this component when used in a configuration.yaml file

getTarget

Class<T> getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

Specified by:

getTarget in interface Configurator<T extends TopLevelItem>

configure

T configure(String name,
 CNode config,
 ConfigurationContext context)
     throws ConfiguratorException

Throws:

ConfiguratorException