Package org.jenkinsci.lib.configprovider.model

Class Config

java.lang.Object

org.jenkinsci.lib.configprovider.model.Config

All Implemented Interfaces:

Describable<Config>, Serializable

Direct Known Subclasses:

CustomConfig, GlobalMavenSettingsConfig, GroovyScript, JsonConfig, MavenSettingsConfig, MavenToolchainsConfig, PropertiesConfig, XmlConfig

public abstract class Config
extends Object
implements Serializable, Describable<Config>

Represents a particular configuration file and its content.

A Config object "belongs to" a ConfigProvider instance.

Author:

domi

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final String	comment	Any note that the author of this configuration wants to associate with this.
final String	content	Content of the file as-is.
final String	id	a unique id along all providers!
final String	name	Human readable display name that distinguishes this Config instance among other Config instances.

Constructor Summary

Constructors

Constructor	Description
Config(String id, String name, String comment, String content)
Config(String id, String name, String comment, String content, String providerId)
Config(Config config)

Method Summary

Modifier and Type	Method	Description
ConfigProvider	getDescriptor()	Gets the ConfigProvider that owns and manages this config.
ConfigProvider	getProvider()	Alias for getDescriptor()
String	getProviderId()
void	setProviderId(String providerId)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

id

public final String id

a unique id along all providers!

name

public final String name

Human readable display name that distinguishes this Config instance among other Config instances.

comment

public final String comment

Any note that the author of this configuration wants to associate with this. Jenkins doesn't use this. Can be null.

content

public final String content

Content of the file as-is.

Constructor Details

Config

public Config(String id,
 String name,
 String comment,
 String content)

Config

public Config(@NonNull
 Config config)

Config

public Config(@NonNull
 String id,
 String name,
 String comment,
 String content,
 @NonNull
 String providerId)

Method Details

getDescriptor

public ConfigProvider getDescriptor()

Gets the ConfigProvider that owns and manages this config.

Specified by:

getDescriptor in interface Describable<Config>

Returns:

never null.

getProvider

public ConfigProvider getProvider()

Alias for getDescriptor()

getProviderId

public String getProviderId()

setProviderId

@DataBoundSetter
public void setProviderId(String providerId)

toString

public String toString()

Overrides:

toString in class Object