Package groovy.lang
Class Script
java.lang.Object
groovy.lang.GroovyObjectSupport
groovy.lang.Script
- All Implemented Interfaces:
GroovyObject
- Direct Known Subclasses:
DelegatingScript
,GroovyTypeCheckingExtensionSupport.TypeCheckingDSL
public abstract class Script extends GroovyObjectSupport
This object represents a Groovy script
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description Object
evaluate(File file)
A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scopeObject
evaluate(String expression)
A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scopeBinding
getBinding()
Object
getProperty(String property)
Retrieves a property value.Object
invokeMethod(String name, Object args)
Invoke a method (or closure in the binding) defined.void
print(Object value)
Prints the value to the current 'out' variable which should be a PrintWriter or at least have a print() method defined on it.void
printf(String format, Object value)
Prints a formatted string using the specified format string and argument.void
printf(String format, Object[] values)
Prints a formatted string using the specified format string and arguments.void
println()
Prints a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it.void
println(Object value)
Prints the value and a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it.abstract Object
run()
The main instance method of a script which has variables in scope as defined by the currentBinding
instance.void
run(File file, String[] arguments)
A helper method to allow scripts to be run taking command line argumentsvoid
setBinding(Binding binding)
void
setProperty(String property, Object newValue)
Sets the given property to the new value.
-
Constructor Details
-
Method Details
-
getBinding
-
setBinding
-
getProperty
Description copied from interface:GroovyObject
Retrieves a property value.- Parameters:
property
- the name of the property of interest- Returns:
- the given property
-
setProperty
Description copied from interface:GroovyObject
Sets the given property to the new value.- Parameters:
property
- the name of the property of interestnewValue
- the new value for the property
-
invokeMethod
Invoke a method (or closure in the binding) defined.- Parameters:
name
- method to callargs
- arguments to pass to the method- Returns:
- value
-
run
The main instance method of a script which has variables in scope as defined by the currentBinding
instance. -
println
public void println()Prints a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it. If there is no 'out' property then print to standard out. -
print
Prints the value to the current 'out' variable which should be a PrintWriter or at least have a print() method defined on it. If there is no 'out' property then print to standard out. -
println
Prints the value and a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it. If there is no 'out' property then print to standard out. -
printf
Prints a formatted string using the specified format string and argument.- Parameters:
format
- the format to followvalue
- the value to be formatted
-
printf
Prints a formatted string using the specified format string and arguments.- Parameters:
format
- the format to followvalues
- an array of values to be formatted
-
evaluate
A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scope- Parameters:
expression
- is the Groovy script expression to evaluate- Throws:
CompilationFailedException
-
evaluate
A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scope- Parameters:
file
- is the Groovy script to evaluate- Throws:
CompilationFailedException
IOException
-
run
A helper method to allow scripts to be run taking command line arguments
-