Package io.jenkins.plugins.casc.core

Class JenkinsConfigurator

java.lang.Object

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

io.jenkins.plugins.casc.core.JenkinsConfigurator

All Implemented Interfaces:

Configurator<Jenkins>, RootElementConfigurator<Jenkins>

@Extension(ordinal=1.0)
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class JenkinsConfigurator
extends BaseConfigurator<Jenkins>
implements RootElementConfigurator<Jenkins>

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
JenkinsConfigurator()

Method Summary

Modifier and Type	Method	Description
Set<Attribute<Jenkins,?>>	describe()	Determine the list of Attribute available for configuration of the managed component.
protected Set<String>	exclusions()	Attribute names that are detected by introspection but should be excluded
String	getName()	Get a configurator name.
Class<Jenkins>	getTarget()	Target type this configurator can handle.
Jenkins	getTargetComponent(ConfigurationContext context)	Retrieve the target component managed by this RootElementConfigurator
protected Jenkins	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, 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, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getNames

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

isRootElement

Constructor Details

JenkinsConfigurator

public JenkinsConfigurator()

Method Details

getTarget

public Class<Jenkins> getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

Specified by:

getTarget in interface Configurator<Jenkins>

getTargetComponent

public Jenkins getTargetComponent(ConfigurationContext context)

Description copied from interface: RootElementConfigurator

Retrieve the target component managed by this RootElementConfigurator

Specified by:

getTargetComponent in interface RootElementConfigurator<Jenkins>

Returns:

instance

protected Jenkins 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<Jenkins>

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)

describe

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

Description copied from interface: Configurator

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

Specified by:

describe in interface Configurator<Jenkins>

Overrides:

describe in class BaseConfigurator<Jenkins>

Returns:

A set of Attributes that describes this object

exclusions

protected Set<String> exclusions()

Description copied from class: BaseConfigurator

Attribute names that are detected by introspection but should be excluded

Overrides:

exclusions in class BaseConfigurator<Jenkins>

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<Jenkins>

Returns:

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