Package groovy.lang
Class GroovyShell
java.lang.Object
groovy.lang.GroovyObjectSupport
groovy.lang.GroovyShell
- All Implemented Interfaces:
- GroovyObject
Represents a groovy shell capable of running arbitrary groovy scripts
- 
Field SummaryFields
- 
Constructor SummaryConstructorsConstructorDescriptionGroovyShell(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 SummaryModifier and TypeMethodDescriptionevaluate(GroovyCodeSource codeSource) Evaluates some script against the current Binding and returns the resultEvaluates some script against the current Binding and returns the resultEvaluates some script against the current Binding and returns the resultEvaluates some script against the current Binding and returns the resultEvaluates some script against the current Binding and returns the resultEvaluates some script against the current Binding and returns the resultEvaluates some script against the current Binding and returns the result.Evaluates some script against the current Binding and returns the resultprotected StringgetProperty(String property) Retrieves a property value.getVariable(String name) static voidparse(GroovyCodeSource codeSource) Parses the given script and returns it ready to be run.parse(GroovyCodeSource codeSource, Binding binding) Parses the given script and returns it ready to be run.Parses the given script and returns it ready to be runParses the given script and returns it ready to be runParses the given script and returns it ready to be runParses the given script and returns it ready to be runParses the given script and returns it ready to be runParses the given script and returns it ready to be runParses the given script and returns it ready to be runParses the given script and returns it ready to be runvoidremoveVariable(String name) voidrun(GroovyCodeSource source, String[] args) Runs the given script source with command line argumentsrun(GroovyCodeSource source, List<String> args) Runs the given script source with command line argumentsRuns the given script file name with the given command line argumentsA helper method which runs the given script file with the given command line argumentsRuns the given script with command line argumentsRuns the given script with command line argumentsRuns the given script text with command line argumentsA helper method which runs the given cl script with the given command line argumentsRuns the given script source with command line argumentsRuns 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) static GroovyShellwithConfig(Closure<Void> spec) Methods inherited from class groovy.lang.GroovyObjectSupportgetMetaClass, setMetaClassMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface groovy.lang.GroovyObjectinvokeMethod
- 
Field Details- 
DEFAULT_CODE_BASE- See Also:
 
 
- 
- 
Constructor Details- 
GroovyShellpublic GroovyShell()
- 
GroovyShell
- 
GroovyShell
- 
GroovyShell
- 
GroovyShell
- 
GroovyShell
- 
GroovyShell
- 
GroovyShell
- 
GroovyShellCreates 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 Details- 
main
- 
withConfigpublic static GroovyShell withConfig(@DelegatesTo(type="org.codehaus.groovy.control.customizers.builder.CompilerCustomizationBuilder") Closure<Void> spec) - Since:
- 4.0.3
 
- 
resetLoadedClassespublic void resetLoadedClasses()
- 
getContext
- 
getClassLoader
- 
getPropertyDescription copied from interface:GroovyObjectRetrieves a property value.- Parameters:
- property- the name of the property of interest
- Returns:
- the given property
 
- 
setPropertyDescription copied from interface:GroovyObjectSets the given property to the new value.- Parameters:
- property- the name of the property of interest
- newValue- the new value for the property
 
- 
runpublic 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 run
- list- the command line arguments to pass in
- Throws:
- CompilationFailedException
- IOException
 
- 
runpublic 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 script
- fileName- 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
 
- 
runRuns the given script file name with the given command line arguments- Parameters:
- scriptFile- the file name of the script to run
- args- the command line arguments to pass in
- Throws:
- CompilationFailedException
- IOException
 
- 
runpublic 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 script
- fileName- 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
 
- 
runRuns the given script source with command line arguments- Parameters:
- source- is the source content of the script
- args- the command line arguments to pass in
- Throws:
- CompilationFailedException
 
- 
runRuns the given script source with command line arguments- Parameters:
- source- is the source content of the script
- args- the command line arguments to pass in
- Throws:
- CompilationFailedException
 
- 
runRuns the given script source with command line arguments- Parameters:
- source- is the source content of the script
- args- the command line arguments to pass in
- Throws:
- CompilationFailedException
- IOException
 
- 
runRuns the given script source with command line arguments- Parameters:
- source- is the source content of the script
- args- the command line arguments to pass in
- Throws:
- CompilationFailedException
- IOException
 
- 
runRuns the given script with command line arguments- Parameters:
- in- the stream reading the script
- fileName- 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
 
- 
runRuns the given script with command line arguments- Parameters:
- in- the stream reading the script
- fileName- 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
 
- 
getVariable
- 
setVariable
- 
removeVariable
- 
evaluateEvaluates some script against the current Binding and returns the result- Parameters:
- codeSource-
- Throws:
- CompilationFailedException
 
- 
evaluateEvaluates some script against the current Binding and returns the result- Parameters:
- scriptText- the text of the script
- Throws:
- CompilationFailedException
 
- 
evaluateEvaluates some script against the current Binding and returns the result- Parameters:
- scriptText- the text of the script
- fileName- is the logical file name of the script (which is used to create the class name of the script)
- Throws:
- CompilationFailedException
 
- 
evaluatepublic 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
 
- 
evaluateEvaluates 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:
- CompilationFailedException
- IOException
 
- 
evaluateEvaluates 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:
- CompilationFailedException
- IOException
 
- 
evaluateEvaluates some script against the current Binding and returns the result- Parameters:
- in- the stream reading the script
- Throws:
- CompilationFailedException
 
- 
evaluateEvaluates some script against the current Binding and returns the result- Parameters:
- in- the stream reading the script
- fileName- is the logical file name of the script (which is used to create the class name of the script)
- Throws:
- CompilationFailedException
 
- 
parseParses the given script and returns it ready to be run- Parameters:
- reader- the stream reading the script
- fileName- 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
 
- 
parsepublic Script parse(Reader reader, String fileName, Binding binding) throws CompilationFailedException Parses the given script and returns it ready to be run- Parameters:
- reader- the stream reading the script
- fileName- is the logical file name of the script (which is used to create the class name of the script)
- binding- the context eval the script
- Returns:
- the parsed script which is ready to be run via Script.run()
- Throws:
- CompilationFailedException
 
- 
parseParses 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-
- binding-
- Returns:
- ready to run script
- Throws:
- CompilationFailedException
 
- 
parseParses 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
 
- 
parseParses 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:
- CompilationFailedException
- IOException
 
- 
parseParses 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:
- CompilationFailedException
- IOException
 
- 
parseParses the given script and returns it ready to be run- Parameters:
- scriptText- the text of the script
- binding- the context eval the script
- Throws:
- CompilationFailedException
 
- 
parseParses the given script and returns it ready to be run- Parameters:
- scriptText- the text of the script
- Throws:
- CompilationFailedException
 
- 
parsepublic Script parse(String scriptText, String fileName, Binding binding) throws CompilationFailedException - Throws:
- CompilationFailedException
 
- 
parse- Throws:
- CompilationFailedException
 
- 
parseParses the given script and returns it ready to be run- Parameters:
- in- the stream reading the script
- Throws:
- CompilationFailedException
 
- 
parseParses the given script and returns it ready to be run- Parameters:
- in- the stream reading the script
- binding- the context eval the script
- Throws:
- CompilationFailedException
 
- 
generateScriptName
 
-