Package io.jenkins.plugins.casc.core

Class GlobalNodePropertiesConfigurator

java.lang.Object

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

io.jenkins.plugins.casc.impl.configurators.DataBoundConfigurator<EnvironmentVariablesNodeProperty>

io.jenkins.plugins.casc.core.GlobalNodePropertiesConfigurator

All Implemented Interfaces:

Configurator<EnvironmentVariablesNodeProperty>

@Extension
public class GlobalNodePropertiesConfigurator
extends DataBoundConfigurator<EnvironmentVariablesNodeProperty>

Nested Class Summary

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

BaseConfigurator.TypePair

Constructor Summary

Constructors

Constructor	Description
GlobalNodePropertiesConfigurator()
GlobalNodePropertiesConfigurator(Class<?> clazz)

Method Summary

Modifier and Type	Method	Description
EnvironmentVariablesNodeProperty	configure(CNode c, ConfigurationContext context)	Configures/creates a Jenkins object based on a tree.
CNode	describe(EnvironmentVariablesNodeProperty instance, ConfigurationContext context)	Describe a component as a Configuration Nodes CNode to be exported as yaml.
String	getName()	Get a configurator name.

Methods inherited from class io.jenkins.plugins.casc.impl.configurators.DataBoundConfigurator

check, describe, getDataBoundConstructor, getDisplayName, getImplementedAPI, getNames, getTarget, instance

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

Constructor Details

GlobalNodePropertiesConfigurator

public GlobalNodePropertiesConfigurator()

GlobalNodePropertiesConfigurator

public GlobalNodePropertiesConfigurator(Class<?> clazz)

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

Overrides:

getName in class DataBoundConfigurator<EnvironmentVariablesNodeProperty>

Returns:

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

configure

@NonNull
public EnvironmentVariablesNodeProperty configure(CNode c,
 ConfigurationContext context)
                                           throws ConfiguratorException

Description copied from interface: Configurator

Configures/creates a Jenkins object based on a tree.

Specified by:

configure in interface Configurator<EnvironmentVariablesNodeProperty>

Overrides:

configure in class DataBoundConfigurator<EnvironmentVariablesNodeProperty>

Parameters:

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

describe

@CheckForNull
public CNode describe(EnvironmentVariablesNodeProperty instance,
 ConfigurationContext context)
               throws Exception

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

Overrides:

describe in class DataBoundConfigurator<EnvironmentVariablesNodeProperty>

Throws:

Exception