org.jenkinsci.lib.configprovider.model
Class Config

java.lang.Object
  org.jenkinsci.lib.configprovider.model.Config

All Implemented Interfaces:

hudson.model.Describable<Config>, java.io.Serializable

public class Config
extends java.lang.Object
implements java.io.Serializable, hudson.model.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

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

Constructor Summary

Config(java.lang.String id, java.lang.String name, java.lang.String comment, java.lang.String content)

Method Summary

ConfigProvider	getDescriptor() Gets the ConfigProvider that owns and manages this config.
ConfigProvider	getProvider() Alias for getProvider()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

public final java.lang.String id

a unique id along all providers!

name

public final java.lang.String name

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

comment

public final java.lang.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 java.lang.String content

Content of the file as-is.

Constructor Detail

Config

@DataBoundConstructor
public Config(java.lang.String id,
                                   java.lang.String name,
                                   java.lang.String comment,
                                   java.lang.String content)

Method Detail

getDescriptor

public ConfigProvider getDescriptor()

Gets the ConfigProvider that owns and manages this config.

Specified by:

getDescriptor in interface hudson.model.Describable<Config>

Returns:

never null.

getProvider

public ConfigProvider getProvider()

Alias for getProvider()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object