org.jenkinsci.plugins.scriptler.config
Class Script

java.lang.Object
  org.jenkinsci.plugins.scriptler.config.Script

All Implemented Interfaces:

Comparable<Script>, NamedResource

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

Field Summary

boolean	available
String	comment
String	name
boolean	nonAdministerUsing
boolean	onlyMaster
String	originCatalog
String	originDate
String	originScript
String	script script is only transient, because it will not be saved in the xml but on the file system.

Constructor Summary

Script(String id, String comment)
used during upload of a new script

Script(String id, String comment, boolean available, boolean nonAdministerUsing, boolean onlyMaster)
used during plugin start to synchronize available scripts

Script(String id, String name, String comment, boolean nonAdministerUsing, Parameter[] parameters, boolean onlyMaster)
used to create/update a new script in the UI

Script(String id, String name, String comment, boolean available, String originCatalog, String originScript, String originDate, boolean nonAdministerUsing, Parameter[] parameters, boolean onlyMaster)
used to merge scripts

Script(String id, String name, String comment, boolean available, String originCatalog, String originScript, String originDate, Parameter[] parameters)
Constructor to create a script imported from a foreign catalog.

Method Summary

int	compareTo(Script o)
boolean	equals(Object obj)
String	getId()
String	getName()
Parameter[]	getParameters()
int	hashCode()
Object	readResolve() Previously we used not to have an id, but only a name.
void	setNonAdministerUsing(boolean nonAdministerUsing)
void	setParameters(Parameter[] parameters)
void	setScript(String script)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

comment

public final String comment

available

public final boolean available

originCatalog

public final String originCatalog

originScript

public final String originScript

originDate

public final String originDate

script

public transient String script

script is only transient, because it will not be saved in the xml but on the file system. Therefore it has to be materialized before usage!

nonAdministerUsing

public boolean nonAdministerUsing

onlyMaster

public boolean onlyMaster

Constructor Detail

Script

@DataBoundConstructor
public Script(String id,
                                   String name,
                                   String comment,
                                   boolean nonAdministerUsing,
                                   Parameter[] parameters,
                                   boolean onlyMaster)

used to create/update a new script in the UI

Script

public Script(String id,
              String comment)

used during upload of a new script

Script

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

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,
              Parameter[] parameters)

Constructor to create a script imported from a foreign catalog.

Script

public Script(String id,
              String name,
              String comment,
              boolean available,
              String originCatalog,
              String originScript,
              String originDate,
              boolean nonAdministerUsing,
              Parameter[] parameters,
              boolean onlyMaster)

used to merge scripts

Method Detail

getName

public String getName()

Specified by:

getName in interface NamedResource

setScript

public void setScript(String script)

setParameters

public void setParameters(Parameter[] parameters)

getParameters

public Parameter[] getParameters()

setNonAdministerUsing

public void setNonAdministerUsing(boolean nonAdministerUsing)

compareTo

public int compareTo(Script o)

Specified by:

compareTo in interface Comparable<Script>

readResolve

public Object readResolve()

Previously we used not to have an id, but only a name.

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)