Package io.jenkins.plugins.casc.core

Class ItemsRootConfigurator

java.lang.Object

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

io.jenkins.plugins.casc.core.ItemsRootConfigurator

All Implemented Interfaces:

Configurator<ItemsRootConfigurator>, RootElementConfigurator<ItemsRootConfigurator>

@Extension
public class ItemsRootConfigurator
extends BaseConfigurator<ItemsRootConfigurator>
implements RootElementConfigurator<ItemsRootConfigurator>

Nested Class Summary

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

BaseConfigurator.TypePair

Constructor Summary

Constructors

Constructor	Description
ItemsRootConfigurator()

Method Summary

Modifier and Type	Method	Description
ItemsRootConfigurator	check(CNode config, ConfigurationContext context)	Run the same logic as Configurator.configure(CNode, ConfigurationContext) in dry-run mode.
ItemsRootConfigurator	configure(CNode config, ConfigurationContext context)	Configures/creates a Jenkins object based on a tree.
Set<Attribute<ItemsRootConfigurator,?>>	describe()	Determine the list of Attribute available for configuration of the managed component.
CNode	describe(ItemsRootConfigurator instance, ConfigurationContext context)	Describe a component as a Configuration Nodes CNode to be exported as yaml.
String	getName()	Get a configurator name.
Class<ItemsRootConfigurator>	getTarget()	Target type this configurator can handle.
ItemsRootConfigurator	getTargetComponent(ConfigurationContext context)	Retrieve the target component managed by this RootElementConfigurator
protected ItemsRootConfigurator	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

compare, 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, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getNames

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

isRootElement

Constructor Details

ItemsRootConfigurator

public ItemsRootConfigurator()

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

Returns:

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

getTarget

public Class<ItemsRootConfigurator> getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

Specified by:

getTarget in interface Configurator<ItemsRootConfigurator>

getTargetComponent

public ItemsRootConfigurator getTargetComponent(ConfigurationContext context)

Description copied from interface: RootElementConfigurator

Retrieve the target component managed by this RootElementConfigurator

Specified by:

getTargetComponent in interface RootElementConfigurator<ItemsRootConfigurator>

Parameters:

context -

Returns:

configure

@NonNull
public ItemsRootConfigurator configure(CNode config,
 ConfigurationContext context)
                                throws ConfiguratorException

Description copied from interface: Configurator

Configures/creates a Jenkins object based on a tree.

Specified by:

configure in interface Configurator<ItemsRootConfigurator>

Overrides:

configure in class BaseConfigurator<ItemsRootConfigurator>

Parameters:

config - Map/List/primitive objects (think YAML) that represents the configuration from which a Jenkins object is configured.

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

Returns:

Fully configured Jenkins object that results from this configuration. if no new objects got created, but some existing objects may have been modified, return updated target object.

Throws:

ConfiguratorException - if something went wrong, depends on the concrete implementation

check

public ItemsRootConfigurator check(CNode config,
 ConfigurationContext context)
                            throws ConfiguratorException

Description copied from interface: Configurator

Run the same logic as Configurator.configure(CNode, ConfigurationContext) in dry-run mode. Used to verify configuration is fine before being actually applied to a live jenkins controller.

Specified by:

check in interface Configurator<ItemsRootConfigurator>

Overrides:

check in class BaseConfigurator<ItemsRootConfigurator>

Parameters:

config - Map/List/primitive objects (think YAML) that represents the configuration from which a Jenkins object is configured.

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

Throws:

ConfiguratorException - on configuration error

instance

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

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)

Throws:

ConfiguratorException - something went wrong...

describe

public CNode describe(ItemsRootConfigurator instance,
 ConfigurationContext context)

Description copied from interface: Configurator

Describe a component as a Configuration Nodes CNode to be exported as yaml. Only export attributes which are not set to default value.

Specified by:

describe in interface Configurator<ItemsRootConfigurator>

describe

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

Description copied from interface: Configurator

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

Specified by:

describe in interface Configurator<ItemsRootConfigurator>

Overrides:

describe in class BaseConfigurator<ItemsRootConfigurator>

Returns:

A set of Attributes that describes this object