Class GlobalConfigurationCategoryConfigurator
- java.lang.Object
-
- io.jenkins.plugins.casc.BaseConfigurator<GlobalConfigurationCategory>
-
- io.jenkins.plugins.casc.impl.configurators.GlobalConfigurationCategoryConfigurator
-
- All Implemented Interfaces:
Configurator<GlobalConfigurationCategory>
,RootElementConfigurator<GlobalConfigurationCategory>
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public class GlobalConfigurationCategoryConfigurator extends BaseConfigurator<GlobalConfigurationCategory> implements RootElementConfigurator<GlobalConfigurationCategory>
- 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 GlobalConfigurationCategoryConfigurator(GlobalConfigurationCategory category)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Set
describe()
Determine the list of Attribute available for configuration of the managed component.CNode
describe(GlobalConfigurationCategory instance, ConfigurationContext context)
Describe a component as a Configuration NodesCNode
to be exported as yaml.String
getName()
Get a configurator name.List<String>
getNames()
Get all possible configurator namesClass
getTarget()
Target type this configurator can handle.GlobalConfigurationCategory
getTargetComponent(ConfigurationContext context)
Retrieve the target component managed by this RootElementConfiguratorprotected GlobalConfigurationCategory
instance(Mapping mapping, ConfigurationContext context)
Build or identify the target component this configurator has to handle based on the provided configuration node.static boolean
reportDescriptorWithoutSetters(Configurator c)
-
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, check, configure, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI
-
Methods inherited from interface io.jenkins.plugins.casc.RootElementConfigurator
isRootElement
-
-
-
-
Constructor Detail
-
GlobalConfigurationCategoryConfigurator
public GlobalConfigurationCategoryConfigurator(GlobalConfigurationCategory category)
-
-
Method Detail
-
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 seeConfigurator.getNames()
for all possible names which will be considered when configuring.- Specified by:
getName
in interfaceConfigurator<GlobalConfigurationCategory>
- Returns:
- short name for this component when used in a configuration.yaml file
-
getNames
@NonNull public List<String> getNames()
Description copied from interface:Configurator
Get all possible configurator names- Specified by:
getNames
in interfaceConfigurator<GlobalConfigurationCategory>
- Returns:
- a list of all possible short names for this component when used in a configuration.yaml file
-
getTarget
public Class getTarget()
Description copied from interface:Configurator
Target type this configurator can handle.- Specified by:
getTarget
in interfaceConfigurator<GlobalConfigurationCategory>
-
getTargetComponent
public GlobalConfigurationCategory getTargetComponent(ConfigurationContext context)
Description copied from interface:RootElementConfigurator
Retrieve the target component managed by this RootElementConfigurator- Specified by:
getTargetComponent
in interfaceRootElementConfigurator<GlobalConfigurationCategory>
- Returns:
-
instance
protected GlobalConfigurationCategory 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 classBaseConfigurator<GlobalConfigurationCategory>
- Parameters:
mapping
- configuration for target component. Implementation may consume some entries to create a fresh new instance.- Returns:
- instance to be configured, but not yet fully configured, see
BaseConfigurator.configure(Mapping, Object, boolean, ConfigurationContext)
-
describe
@NonNull public Set describe()
Description copied from interface:Configurator
Determine the list of Attribute available for configuration of the managed component.- Specified by:
describe
in interfaceConfigurator<GlobalConfigurationCategory>
- Overrides:
describe
in classBaseConfigurator<GlobalConfigurationCategory>
- Returns:
- A set of
Attribute
s that describes this object
-
reportDescriptorWithoutSetters
public static boolean reportDescriptorWithoutSetters(Configurator c)
-
describe
@CheckForNull public CNode describe(GlobalConfigurationCategory instance, ConfigurationContext context)
Description copied from interface:Configurator
Describe a component as a Configuration NodesCNode
to be exported as yaml. Only export attributes which are not set to default value.- Specified by:
describe
in interfaceConfigurator<GlobalConfigurationCategory>
-
-