Package org.jenkinsci.plugins.scriptler.config

Class Script

java.lang.Object

org.jenkinsci.plugins.scriptler.config.Script

All Implemented Interfaces:

Serializable, Comparable<Script>, NamedResource

public class Script
extends Object
implements Comparable<Script>, NamedResource, Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final String	comment
static final Comparator<Script>	COMPARATOR_BY_NAME
final String	name
final boolean	nonAdministerUsing
final boolean	onlyBuiltIn
final Boolean	onlyController	Deprecated. Use onlyBuiltIn instead.
final Boolean	onlyMaster	Deprecated. Use onlyBuiltIn instead.
final String	originCatalog
final String	originDate
final String	originScript
String	script	Deprecated. Use getScriptText() and setScriptText(String) instead.

Constructor Summary

Constructors

Constructor	Description
Script(String id, String comment, boolean available, boolean nonAdministerUsing, boolean onlyBuiltIn)	used during plugin start to synchronize available scripts
Script(String id, String name, String comment, boolean available, String originCatalog, String originScript, String originDate, boolean nonAdministerUsing, List<Parameter> parameters, boolean onlyBuiltIn)	used to merge scripts
Script(String id, String name, String comment, boolean available, String originCatalog, String originScript, String originDate, List<Parameter> parameters)	Constructor to create a script imported from a foreign catalog.
Script(String id, String name, String comment, boolean nonAdministerUsing, List<Parameter> parameters, boolean onlyBuiltIn)	used to create/update a new script in the UI
Script(String id, String name, String comment, String originCatalog, String originScript, String originDate, boolean nonAdministerUsing, List<Parameter> parameters, boolean onlyBuiltIn)	used to merge scripts

Method Summary

Modifier and Type	Method	Description
int	compareTo(Script o)
Script	copy()
boolean	equals(Object obj)
String	getId()
String	getName()
String	getNonNullName()
List<Parameter>	getParameters()
String	getScript()	Deprecated. Use getScriptText() instead.
String	getScriptPath()
String	getScriptText()
int	hashCode()
boolean	isAvailable()
Object	readResolve()
void	setAvailable(boolean available)
void	setParameters(List<Parameter> parameters)
void	setScript(String scriptText)	Deprecated. Use setScriptText(String) instead.
void	setScriptText(String scriptText)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

name

public final String name

comment

public final String comment

originCatalog

public final String originCatalog

originScript

public final String originScript

originDate

public final String originDate

script

@Deprecated(since="384")
public transient String script

Deprecated.

Use getScriptText() and setScriptText(String) instead.

nonAdministerUsing

public final boolean nonAdministerUsing

onlyBuiltIn

public final boolean onlyBuiltIn

onlyController

@Deprecated(since="386")
public final Boolean onlyController

Deprecated.

Use onlyBuiltIn instead.

onlyMaster

@Deprecated(since="381")
public final Boolean onlyMaster

Deprecated.

Use onlyBuiltIn instead.

COMPARATOR_BY_NAME

public static final Comparator<Script> COMPARATOR_BY_NAME

Constructor Details

Script

public Script(String id,
 String name,
 String comment,
 boolean nonAdministerUsing,
 @NonNull
 List<Parameter> parameters,
 boolean onlyBuiltIn)

used to create/update a new script in the UI

Script

public Script(String id,
 String comment,
 boolean available,
 boolean nonAdministerUsing,
 boolean onlyBuiltIn)

used during plugin start to synchronize available scripts

Script

public Script(String id,
 String name,
 String comment,
 boolean available,
 String originCatalog,
 String originScript,
 String originDate,
 @NonNull
 List<Parameter> parameters)

Constructor to create a script imported from a foreign catalog.

Script

public Script(String id,
 String name,
 String comment,
 String originCatalog,
 String originScript,
 String originDate,
 boolean nonAdministerUsing,
 @NonNull
 List<Parameter> parameters,
 boolean onlyBuiltIn)

used to merge scripts

Script

public Script(String id,
 String name,
 String comment,
 boolean available,
 String originCatalog,
 String originScript,
 String originDate,
 boolean nonAdministerUsing,
 @NonNull
 List<Parameter> parameters,
 boolean onlyBuiltIn)

used to merge scripts

Method Details

copy

public Script copy()

getName

public String getName()

Specified by:

getName in interface NamedResource

getNonNullName

public String getNonNullName()

getScriptPath

public String getScriptPath()

isAvailable

public boolean isAvailable()

setAvailable

public void setAvailable(boolean available)

getScriptText

@CheckForNull
public String getScriptText()

getScript

@CheckForNull
@Deprecated(since="381")
public String getScript()

Deprecated.

Use getScriptText() instead.

setScriptText

public void setScriptText(String scriptText)

setScript

@Deprecated(since="381")
public void setScript(String scriptText)

Deprecated.

Use setScriptText(String) instead.

setParameters

public void setParameters(@NonNull
 List<Parameter> parameters)

getParameters

@NonNull
public List<Parameter> getParameters()

compareTo

public int compareTo(Script o)

Specified by:

compareTo in interface Comparable<Script>

readResolve

public Object readResolve()

getId

public String getId()

Specified by:

getId in interface NamedResource

Returns:

the id

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)