Package io.jenkins.plugins.casc.core

Class FreestyleItemConfigurator

java.lang.Object

io.jenkins.plugins.casc.BaseConfigurator<FreeStyleProject>

io.jenkins.plugins.casc.core.FreestyleItemConfigurator

All Implemented Interfaces:

ExtensionPoint, Configurator<FreeStyleProject>, ItemConfigurator<FreeStyleProject>

@Extension
public class FreestyleItemConfigurator
extends BaseConfigurator<FreeStyleProject>
implements ItemConfigurator<FreeStyleProject>

Nested Class Summary

Nested classes/interfaces inherited from class io.jenkins.plugins.casc.BaseConfigurator

BaseConfigurator.TypePair

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
FreestyleItemConfigurator()

Method Summary

Modifier and Type	Method	Description
FreeStyleProject	configure(String name, CNode config, ConfigurationContext context)
Set<Attribute<FreeStyleProject,?>>	describe()	Determine the list of Attribute available for configuration of the managed component.
String	getName()	Get a configurator name.
Class<FreeStyleProject>	getTarget()	Target type this configurator can handle.
protected FreeStyleProject	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, 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, describe, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getNames

Constructor Details

FreestyleItemConfigurator

public FreestyleItemConfigurator()

Method Details

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 see Configurator.getNames() for all possible names which will be considered when configuring.

Specified by:

getName in interface Configurator<FreeStyleProject>

Specified by:

getName in interface ItemConfigurator<FreeStyleProject>

Returns:

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

getTarget

public Class<FreeStyleProject> getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

Specified by:

getTarget in interface Configurator<FreeStyleProject>

Specified by:

getTarget in interface ItemConfigurator<FreeStyleProject>

describe

@NonNull
public Set<Attribute<FreeStyleProject,?>> describe()

Description copied from interface: Configurator

Determine the list of Attribute available for configuration of the managed component.

Specified by:

describe in interface Configurator<FreeStyleProject>

Overrides:

describe in class BaseConfigurator<FreeStyleProject>

Returns:

A set of Attributes that describes this object

instance

protected FreeStyleProject 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 class BaseConfigurator<FreeStyleProject>

Parameters:

mapping - configuration for target component. Implementation may consume some entries to create a fresh new instance.

context - Fully configured Jenkins object used as the starting point for this configuration.

Returns:

instance to be configured, but not yet fully configured, see BaseConfigurator.configure(Mapping, Object, boolean, ConfigurationContext)

configure

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

Specified by:

configure in interface ItemConfigurator<FreeStyleProject>

Throws:

ConfiguratorException