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
Fields Modifier and Type Field Description boolean
available
String
comment
static Comparator<Script>
COMPARATOR_BY_NAME
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
Constructors Constructor Description Script(String id, String comment, boolean available, boolean nonAdministerUsing, boolean onlyMaster)
used during plugin start to synchronize available scriptsScript(String id, String name, String comment, boolean available, String originCatalog, String originScript, String originDate, boolean nonAdministerUsing, List<Parameter> parameters, boolean onlyMaster)
used to merge scriptsScript(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 onlyMaster)
used to create/update a new script in the UIScript(String id, String name, String comment, String originCatalog, String originScript, String originDate, boolean nonAdministerUsing, List<Parameter> parameters, boolean onlyMaster)
used to merge scripts
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Script o)
Script
copy()
boolean
equals(Object obj)
String
getId()
String
getName()
List<Parameter>
getParameters()
String
getScriptPath()
int
hashCode()
Object
readResolve()
Previously we used not to have an id, but only a name.void
setAvailable(boolean available)
void
setParameters(List<Parameter> parameters)
void
setScript(String script)
String
toString()
-
-
-
Field Detail
-
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
-
available
public boolean available
-
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 final boolean nonAdministerUsing
-
onlyMaster
public final boolean onlyMaster
-
COMPARATOR_BY_NAME
public static final Comparator<Script> COMPARATOR_BY_NAME
-
-
Constructor Detail
-
Script
public Script(String id, String name, String comment, boolean nonAdministerUsing, @NonNull List<Parameter> parameters, boolean onlyMaster)
used to create/update a new script in the UI
-
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, @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 onlyMaster)
used to merge scripts
-
-
Method Detail
-
copy
public Script copy()
-
getName
public String getName()
- Specified by:
getName
in interfaceNamedResource
-
getScriptPath
public String getScriptPath()
-
setAvailable
public void setAvailable(boolean available)
-
setScript
public void setScript(String script)
-
compareTo
public int compareTo(Script o)
- Specified by:
compareTo
in interfaceComparable<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 interfaceNamedResource
- Returns:
- the id
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classObject
- See Also:
Object.hashCode()
-
equals
public boolean equals(Object obj)
- Overrides:
equals
in classObject
- See Also:
Object.equals(java.lang.Object)
-
-