groovy.lang
Class GroovyShell

java.lang.Object
  extended bygroovy.lang.GroovyObjectSupport
      extended bygroovy.lang.GroovyShell
All Implemented Interfaces:
GroovyObject

public class GroovyShell
extends GroovyObjectSupport

Represents a groovy shell capable of running arbitrary groovy scripts

Version:
$Revision: 1.19 $
Author:
James Strachan, Guillaume Laforge

Field Summary
static java.lang.String[] EMPTY_ARGS
           
 
Constructor Summary
GroovyShell()
           
GroovyShell(Binding binding)
           
GroovyShell(Binding binding, CompilerConfig config)
           
GroovyShell(java.lang.ClassLoader parent, Binding binding)
           
GroovyShell(java.lang.ClassLoader parent, Binding binding, CompilerConfig config)
           
GroovyShell(GroovyShell shell)
          Creates a child shell using a new ClassLoader which uses the parent shell's class loader as its parent
 
Method Summary
 java.lang.Object evaluate(java.io.File file)
          Evaluates some script against the current Binding and returns the result
 java.lang.Object evaluate(java.io.InputStream in)
          Evaluates some script against the current Binding and returns the result
 java.lang.Object evaluate(java.io.InputStream in, java.lang.String fileName)
          Evaluates some script against the current Binding and returns the result
 java.lang.Object evaluate(java.lang.String scriptText)
          Evaluates some script against the current Binding and returns the result
 java.lang.Object evaluate(java.lang.String scriptText, java.lang.String fileName)
          Evaluates some script against the current Binding and returns the result
protected  java.lang.String generateScriptName()
           
 Binding getContext()
           
 java.lang.Object getProperty(java.lang.String property)
           
 java.lang.Object getVariable(java.lang.String name)
           
static void main(java.lang.String[] args)
           
 Script parse(java.io.File file)
          Parses the given script and returns it ready to be run
 Script parse(java.io.InputStream in)
          Parses the given script and returns it ready to be run
 Script parse(java.io.InputStream in, java.lang.String fileName)
          Parses the given script and returns it ready to be run
 Script parse(java.lang.String scriptText)
          Parses the given script and returns it ready to be run
 Script parse(java.lang.String scriptText, java.lang.String fileName)
          Parses the given script and returns it ready to be run
 void run(java.io.File scriptFile, java.util.List list)
          A helper method which runs the given script file with the given command line arguments
 void run(java.io.File scriptFile, java.lang.String[] args)
          Runs the given script file name with the given command line arguments
 java.lang.Object run(java.io.InputStream in, java.lang.String fileName, java.lang.String[] args)
          Runs the given script with command line arguments
 void run(java.lang.String scriptText, java.lang.String fileName, java.lang.String[] args)
          Runs the given script text with command line arguments
 void setProperty(java.lang.String property, java.lang.Object newValue)
          Sets the given property to the new value
 void setVariable(java.lang.String name, java.lang.Object value)
           
 
Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, invokeMethod, setMetaClass
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY_ARGS

public static final java.lang.String[] EMPTY_ARGS
Constructor Detail

GroovyShell

public GroovyShell()

GroovyShell

public GroovyShell(Binding binding)

GroovyShell

public GroovyShell(Binding binding,
                   CompilerConfig config)

GroovyShell

public GroovyShell(java.lang.ClassLoader parent,
                   Binding binding)

GroovyShell

public GroovyShell(java.lang.ClassLoader parent,
                   Binding binding,
                   CompilerConfig 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(java.lang.String[] args)

getContext

public Binding getContext()

getProperty

public java.lang.Object getProperty(java.lang.String property)
Specified by:
getProperty in interface GroovyObject
Overrides:
getProperty in class GroovyObjectSupport

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object newValue)
Description copied from interface: GroovyObject
Sets the given property to the new value

Specified by:
setProperty in interface GroovyObject
Overrides:
setProperty in class GroovyObjectSupport

run

public void run(java.io.File scriptFile,
                java.util.List list)
         throws java.lang.ClassNotFoundException,
                SyntaxException,
                java.io.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:
java.lang.ClassNotFoundException
SyntaxException
java.io.IOException

run

public void run(java.io.File scriptFile,
                java.lang.String[] args)
         throws java.lang.ClassNotFoundException,
                SyntaxException,
                java.io.IOException
Runs 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:
java.lang.ClassNotFoundException
SyntaxException
java.io.IOException

run

public void run(java.lang.String scriptText,
                java.lang.String fileName,
                java.lang.String[] args)
         throws java.lang.ClassNotFoundException,
                SyntaxException,
                java.io.IOException
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:
java.lang.ClassNotFoundException
SyntaxException
java.io.IOException

run

public java.lang.Object run(java.io.InputStream in,
                            java.lang.String fileName,
                            java.lang.String[] args)
                     throws java.lang.ClassNotFoundException,
                            SyntaxException,
                            java.io.IOException
Runs 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:
java.lang.ClassNotFoundException
SyntaxException
java.io.IOException

getVariable

public java.lang.Object getVariable(java.lang.String name)

setVariable

public void setVariable(java.lang.String name,
                        java.lang.Object value)

evaluate

public java.lang.Object evaluate(java.lang.String scriptText,
                                 java.lang.String fileName)
                          throws SyntaxException,
                                 java.lang.ClassNotFoundException,
                                 java.io.IOException
Evaluates 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:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

evaluate

public java.lang.Object evaluate(java.io.File file)
                          throws SyntaxException,
                                 java.lang.ClassNotFoundException,
                                 java.io.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:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

evaluate

public java.lang.Object evaluate(java.lang.String scriptText)
                          throws SyntaxException,
                                 java.lang.ClassNotFoundException,
                                 java.io.IOException
Evaluates some script against the current Binding and returns the result

Parameters:
scriptText - the text of the script
Throws:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

evaluate

public java.lang.Object evaluate(java.io.InputStream in)
                          throws SyntaxException,
                                 java.lang.ClassNotFoundException,
                                 java.io.IOException
Evaluates some script against the current Binding and returns the result

Parameters:
in - the stream reading the script
Throws:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

evaluate

public java.lang.Object evaluate(java.io.InputStream in,
                                 java.lang.String fileName)
                          throws SyntaxException,
                                 java.lang.ClassNotFoundException,
                                 java.io.IOException
Evaluates 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:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

parse

public Script parse(java.io.InputStream in,
                    java.lang.String fileName)
             throws SyntaxException,
                    java.lang.ClassNotFoundException,
                    java.io.IOException
Parses the given script and returns it ready to be run

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)
Returns:
the parsed script which is ready to be run via @link Script.run()
Throws:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

parse

public Script parse(java.lang.String scriptText,
                    java.lang.String fileName)
             throws SyntaxException,
                    java.lang.ClassNotFoundException,
                    java.io.IOException
Parses the given script and returns it ready to be run

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:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

parse

public Script parse(java.io.File file)
             throws SyntaxException,
                    java.lang.ClassNotFoundException,
                    java.io.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:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

parse

public Script parse(java.lang.String scriptText)
             throws SyntaxException,
                    java.lang.ClassNotFoundException,
                    java.io.IOException
Parses the given script and returns it ready to be run

Parameters:
scriptText - the text of the script
Throws:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

parse

public Script parse(java.io.InputStream in)
             throws SyntaxException,
                    java.lang.ClassNotFoundException,
                    java.io.IOException
Parses the given script and returns it ready to be run

Parameters:
in - the stream reading the script
Throws:
SyntaxException
java.lang.ClassNotFoundException
java.io.IOException

generateScriptName

protected java.lang.String generateScriptName()


Copyright © 2003-2004 The Codehaus. All Rights Reserved.