Package groovy.lang
Class GroovyShell
- java.lang.Object
-
- groovy.lang.GroovyObjectSupport
-
- groovy.lang.GroovyShell
-
- All Implemented Interfaces:
GroovyObject
public class GroovyShell extends GroovyObjectSupport
Represents a groovy shell capable of running arbitrary groovy scripts
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_CODE_BASE
-
Constructor Summary
Constructors Constructor Description GroovyShell()GroovyShell(Binding binding)GroovyShell(Binding binding, CompilerConfiguration config)GroovyShell(GroovyShell shell)Creates a child shell using a new ClassLoader which uses the parent shell's class loader as its parentGroovyShell(ClassLoader parent)GroovyShell(ClassLoader parent, Binding binding)GroovyShell(ClassLoader parent, Binding binding, CompilerConfiguration config)GroovyShell(ClassLoader parent, CompilerConfiguration config)GroovyShell(CompilerConfiguration config)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectevaluate(GroovyCodeSource codeSource)Evaluates some script against the current Binding and returns the resultObjectevaluate(File file)Evaluates some script against the current Binding and returns the resultObjectevaluate(Reader in)Evaluates some script against the current Binding and returns the resultObjectevaluate(Reader in, String fileName)Evaluates some script against the current Binding and returns the resultObjectevaluate(String scriptText)Evaluates some script against the current Binding and returns the resultObjectevaluate(String scriptText, String fileName)Evaluates some script against the current Binding and returns the resultObjectevaluate(String scriptText, String fileName, String codeBase)Evaluates some script against the current Binding and returns the result.Objectevaluate(URI uri)Evaluates some script against the current Binding and returns the resultprotected StringgenerateScriptName()GroovyClassLoadergetClassLoader()BindinggetContext()ObjectgetProperty(String property)Retrieves a property value.ObjectgetVariable(String name)static voidmain(String[] args)Scriptparse(GroovyCodeSource codeSource)Parses the given script and returns it ready to be run.Scriptparse(File file)Parses the given script and returns it ready to be runScriptparse(Reader in)Parses the given script and returns it ready to be runScriptparse(Reader reader, String fileName)Parses the given script and returns it ready to be runScriptparse(String scriptText)Parses the given script and returns it ready to be runScriptparse(String scriptText, String fileName)Scriptparse(URI uri)Parses the given script and returns it ready to be runvoidremoveVariable(String name)voidresetLoadedClasses()Objectrun(GroovyCodeSource source, String[] args)Runs the given script source with command line argumentsObjectrun(GroovyCodeSource source, List<String> args)Runs the given script source with command line argumentsObjectrun(File scriptFile, String[] args)Runs the given script file name with the given command line argumentsObjectrun(File scriptFile, List<String> list)A helper method which runs the given script file with the given command line argumentsObjectrun(Reader in, String fileName, String[] args)Runs the given script with command line argumentsObjectrun(Reader in, String fileName, List<String> list)Runs the given script with command line argumentsObjectrun(String scriptText, String fileName, String[] args)Runs the given script text with command line argumentsObjectrun(String scriptText, String fileName, List<String> list)A helper method which runs the given cl script with the given command line argumentsObjectrun(URI source, String[] args)Runs the given script source with command line argumentsObjectrun(URI source, List<String> args)Runs the given script source with command line argumentsvoidsetProperty(String property, Object newValue)Sets the given property to the new value.voidsetVariable(String name, Object value)-
Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, setMetaClass
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface groovy.lang.GroovyObject
invokeMethod
-
-
-
-
Field Detail
-
DEFAULT_CODE_BASE
public static final String DEFAULT_CODE_BASE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GroovyShell
public GroovyShell()
-
GroovyShell
public GroovyShell(Binding binding)
-
GroovyShell
public GroovyShell(ClassLoader parent, CompilerConfiguration config)
-
GroovyShell
public GroovyShell(CompilerConfiguration config)
-
GroovyShell
public GroovyShell(Binding binding, CompilerConfiguration config)
-
GroovyShell
public GroovyShell(ClassLoader parent, Binding binding)
-
GroovyShell
public GroovyShell(ClassLoader parent)
-
GroovyShell
public GroovyShell(ClassLoader parent, Binding binding, CompilerConfiguration config)
-
GroovyShell
public GroovyShell(GroovyShell shell)
Creates a child shell using a new ClassLoader which uses the parent shell's class loader as its parent- Parameters:
shell- is the parent shell used for the variable bindings and the parent class loader
-
-
Method Detail
-
main
public static void main(String[] args)
-
resetLoadedClasses
public void resetLoadedClasses()
-
getContext
public Binding getContext()
-
getClassLoader
public GroovyClassLoader getClassLoader()
-
getProperty
public Object getProperty(String property)
Description copied from interface:GroovyObjectRetrieves a property value.- Parameters:
property- the name of the property of interest- Returns:
- the given property
-
setProperty
public void setProperty(String property, Object newValue)
Description copied from interface:GroovyObjectSets the given property to the new value.- Parameters:
property- the name of the property of interestnewValue- the new value for the property
-
run
public Object run(File scriptFile, List<String> list) throws CompilationFailedException, IOException
A helper method which runs the given script file with the given command line arguments- Parameters:
scriptFile- the file of the script to runlist- the command line arguments to pass in- Throws:
CompilationFailedExceptionIOException
-
run
public Object run(String scriptText, String fileName, List<String> list) throws CompilationFailedException
A helper method which runs the given cl script with the given command line arguments- Parameters:
scriptText- is the text content of the scriptfileName- is the logical file name of the script (which is used to create the class name of the script)list- the command line arguments to pass in- Throws:
CompilationFailedException
-
run
public Object run(File scriptFile, String[] args) throws CompilationFailedException, IOException
Runs the given script file name with the given command line arguments- Parameters:
scriptFile- the file name of the script to runargs- the command line arguments to pass in- Throws:
CompilationFailedExceptionIOException
-
run
public Object run(String scriptText, String fileName, String[] args) throws CompilationFailedException
Runs the given script text with command line arguments- Parameters:
scriptText- is the text content of the scriptfileName- is the logical file name of the script (which is used to create the class name of the script)args- the command line arguments to pass in- Throws:
CompilationFailedException
-
run
public Object run(GroovyCodeSource source, List<String> args) throws CompilationFailedException
Runs the given script source with command line arguments- Parameters:
source- is the source content of the scriptargs- the command line arguments to pass in- Throws:
CompilationFailedException
-
run
public Object run(GroovyCodeSource source, String[] args) throws CompilationFailedException
Runs the given script source with command line arguments- Parameters:
source- is the source content of the scriptargs- the command line arguments to pass in- Throws:
CompilationFailedException
-
run
public Object run(URI source, List<String> args) throws CompilationFailedException, IOException
Runs the given script source with command line arguments- Parameters:
source- is the source content of the scriptargs- the command line arguments to pass in- Throws:
CompilationFailedExceptionIOException
-
run
public Object run(URI source, String[] args) throws CompilationFailedException, IOException
Runs the given script source with command line arguments- Parameters:
source- is the source content of the scriptargs- the command line arguments to pass in- Throws:
CompilationFailedExceptionIOException
-
run
public Object run(Reader in, String fileName, List<String> list) throws CompilationFailedException
Runs the given script with command line arguments- Parameters:
in- the stream reading the scriptfileName- is the logical file name of the script (which is used to create the class name of the script)list- the command line arguments to pass in- Throws:
CompilationFailedException
-
run
public Object run(Reader in, String fileName, String[] args) throws CompilationFailedException
Runs the given script with command line arguments- Parameters:
in- the stream reading the scriptfileName- is the logical file name of the script (which is used to create the class name of the script)args- the command line arguments to pass in- Throws:
CompilationFailedException
-
removeVariable
public void removeVariable(String name)
-
evaluate
public Object evaluate(GroovyCodeSource codeSource) throws CompilationFailedException
Evaluates some script against the current Binding and returns the result- Parameters:
codeSource-- Throws:
CompilationFailedException
-
evaluate
public Object evaluate(String scriptText) throws CompilationFailedException
Evaluates some script against the current Binding and returns the result- Parameters:
scriptText- the text of the script- Throws:
CompilationFailedException
-
evaluate
public Object evaluate(String scriptText, String fileName) throws CompilationFailedException
Evaluates some script against the current Binding and returns the result- Parameters:
scriptText- the text of the scriptfileName- is the logical file name of the script (which is used to create the class name of the script)- Throws:
CompilationFailedException
-
evaluate
public Object evaluate(String scriptText, String fileName, String codeBase) throws CompilationFailedException
Evaluates some script against the current Binding and returns the result. The .class file created from the script is given the supplied codeBase- Throws:
CompilationFailedException
-
evaluate
public Object evaluate(File file) throws CompilationFailedException, IOException
Evaluates some script against the current Binding and returns the result- Parameters:
file- is the file of the script (which is used to create the class name of the script)- Throws:
CompilationFailedExceptionIOException
-
evaluate
public Object evaluate(URI uri) throws CompilationFailedException, IOException
Evaluates some script against the current Binding and returns the result- Parameters:
uri- is the URI of the script (which is used to create the class name of the script)- Throws:
CompilationFailedExceptionIOException
-
evaluate
public Object evaluate(Reader in) throws CompilationFailedException
Evaluates some script against the current Binding and returns the result- Parameters:
in- the stream reading the script- Throws:
CompilationFailedException
-
evaluate
public Object evaluate(Reader in, String fileName) throws CompilationFailedException
Evaluates some script against the current Binding and returns the result- Parameters:
in- the stream reading the scriptfileName- is the logical file name of the script (which is used to create the class name of the script)- Throws:
CompilationFailedException
-
parse
public Script parse(Reader reader, String fileName) throws CompilationFailedException
Parses the given script and returns it ready to be run- Parameters:
reader- the stream reading the scriptfileName- is the logical file name of the script (which is used to create the class name of the script)- Returns:
- the parsed script which is ready to be run via
Script.run() - Throws:
CompilationFailedException
-
parse
public Script parse(GroovyCodeSource codeSource) throws CompilationFailedException
Parses the given script and returns it ready to be run. When running in a secure environment (-Djava.security.manager) codeSource.getCodeSource() determines what policy grants should be given to the script.- Parameters:
codeSource-- Returns:
- ready to run script
- Throws:
CompilationFailedException
-
parse
public Script parse(File file) throws CompilationFailedException, IOException
Parses the given script and returns it ready to be run- Parameters:
file- is the file of the script (which is used to create the class name of the script)- Throws:
CompilationFailedExceptionIOException
-
parse
public Script parse(URI uri) throws CompilationFailedException, IOException
Parses the given script and returns it ready to be run- Parameters:
uri- is the URI of the script (which is used to create the class name of the script)- Throws:
CompilationFailedExceptionIOException
-
parse
public Script parse(String scriptText) throws CompilationFailedException
Parses the given script and returns it ready to be run- Parameters:
scriptText- the text of the script- Throws:
CompilationFailedException
-
parse
public Script parse(String scriptText, String fileName) throws CompilationFailedException
- Throws:
CompilationFailedException
-
parse
public Script parse(Reader in) throws CompilationFailedException
Parses the given script and returns it ready to be run- Parameters:
in- the stream reading the script- Throws:
CompilationFailedException
-
generateScriptName
protected String generateScriptName()
-
-