com.cloudbees.jenkins.plugins.advisor.casc

Class AdvisorRootConfigurator

java.lang.Object

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

com.cloudbees.jenkins.plugins.advisor.casc.AdvisorRootConfigurator

All Implemented Interfaces:

io.jenkins.plugins.casc.Configurator<AdvisorGlobalConfiguration>, io.jenkins.plugins.casc.RootElementConfigurator<AdvisorGlobalConfiguration>

@Extension(optional=true)
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class AdvisorRootConfigurator
extends io.jenkins.plugins.casc.BaseConfigurator<AdvisorGlobalConfiguration>
implements io.jenkins.plugins.casc.RootElementConfigurator<AdvisorGlobalConfiguration>

A root element configurator used for configuring CloudBees Jenkins Advisor through ConfigurationAsCode https://github.com/jenkinsci/configuration-as-code-plugin

Nested Class Summary

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

io.jenkins.plugins.casc.BaseConfigurator.TypePair

Constructor Summary

Constructors

Constructor and Description
AdvisorRootConfigurator()

Method Summary

Modifier and Type	Method and Description
io.jenkins.plugins.casc.model.CNode	describe(AdvisorGlobalConfiguration instance, io.jenkins.plugins.casc.ConfigurationContext context)
String	getDisplayName()
String	getName()
Class<AdvisorGlobalConfiguration>	getTarget()
AdvisorGlobalConfiguration	getTargetComponent(io.jenkins.plugins.casc.ConfigurationContext configurationContext)
protected AdvisorGlobalConfiguration	instance(io.jenkins.plugins.casc.model.Mapping mapping, io.jenkins.plugins.casc.ConfigurationContext configurationContext)

Methods inherited from class io.jenkins.plugins.casc.BaseConfigurator

check, compare, configure, configure, createAttribute, describe, 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.RootElementConfigurator

all, isRootElement

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

canConfigure, check, configure, describe, describeStructure, getAttributes, getConfigurators, getImplementedAPI, normalize

Constructor Detail

AdvisorRootConfigurator

public AdvisorRootConfigurator()

Method Detail

getName

@NonNull
public String getName()

Specified by:

getName in interface io.jenkins.plugins.casc.Configurator<AdvisorGlobalConfiguration>

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface io.jenkins.plugins.casc.Configurator<AdvisorGlobalConfiguration>

instance

protected AdvisorGlobalConfiguration instance(io.jenkins.plugins.casc.model.Mapping mapping,
                                              io.jenkins.plugins.casc.ConfigurationContext configurationContext)
                                       throws io.jenkins.plugins.casc.ConfiguratorException

Specified by:

instance in class io.jenkins.plugins.casc.BaseConfigurator<AdvisorGlobalConfiguration>

Throws:

io.jenkins.plugins.casc.ConfiguratorException

getTargetComponent

public AdvisorGlobalConfiguration getTargetComponent(io.jenkins.plugins.casc.ConfigurationContext configurationContext)

Specified by:

getTargetComponent in interface io.jenkins.plugins.casc.RootElementConfigurator<AdvisorGlobalConfiguration>

getTarget

public Class<AdvisorGlobalConfiguration> getTarget()

Specified by:

getTarget in interface io.jenkins.plugins.casc.Configurator<AdvisorGlobalConfiguration>

describe

@CheckForNull
public io.jenkins.plugins.casc.model.CNode describe(AdvisorGlobalConfiguration instance,
                                                                  io.jenkins.plugins.casc.ConfigurationContext context)
                                                           throws Exception

Specified by:

describe in interface io.jenkins.plugins.casc.Configurator<AdvisorGlobalConfiguration>

Throws:

Exception