org.jenkinsci.plugins.workflow.cps.global

Class UserDefinedGlobalVariable

java.lang.Object

org.jenkinsci.plugins.workflow.cps.GlobalVariable

org.jenkinsci.plugins.workflow.cps.global.UserDefinedGlobalVariable

All Implemented Interfaces:

ExtensionPoint

public class UserDefinedGlobalVariable
extends org.jenkinsci.plugins.workflow.cps.GlobalVariable

Global variable backed by user-supplied script.

Author:

Kohsuke Kawaguchi

See Also:

UserDefinedGlobalVariableList

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class org.jenkinsci.plugins.workflow.cps.GlobalVariable

ALL

Constructor Summary

Constructors

Constructor and Description
UserDefinedGlobalVariable(String name, File help)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getHelpHtml() Loads help from user-defined file, if available.
String	getName()
Object	getValue(org.jenkinsci.plugins.workflow.cps.CpsScript script)
int	hashCode()

Methods inherited from class org.jenkinsci.plugins.workflow.cps.GlobalVariable

byName, forJob, forRun

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDefinedGlobalVariable

public UserDefinedGlobalVariable(String name,
                                 File help)

Method Detail

getName

@NonNull
public String getName()

Specified by:

getName in class org.jenkinsci.plugins.workflow.cps.GlobalVariable

getValue

@NonNull
public Object getValue(@NonNull
                                org.jenkinsci.plugins.workflow.cps.CpsScript script)
                         throws Exception

Specified by:

getValue in class org.jenkinsci.plugins.workflow.cps.GlobalVariable

Throws:

Exception

getHelpHtml

@CheckForNull
public String getHelpHtml()
                                 throws IOException

Loads help from user-defined file, if available.

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object