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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.Objectevaluate(java.io.File file)A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scopejava.lang.Objectevaluate(java.lang.String expression)A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scopeBindinggetBinding()java.lang.ObjectgetProperty(java.lang.String property)Retrieves a property value.java.lang.ObjectinvokeMethod(java.lang.String name, java.lang.Object args)Invoke a method (or closure in the binding) defined.voidprint(java.lang.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.voidprintf(java.lang.String format, java.lang.Object value)Prints a formatted string using the specified format string and argument.voidprintf(java.lang.String format, java.lang.Object[] values)Prints a formatted string using the specified format string and arguments.voidprintln()Prints a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it.voidprintln(java.lang.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 java.lang.Objectrun()The main instance method of a script which has variables in scope as defined by the currentBindinginstance.voidrun(java.io.File file, java.lang.String[] arguments)A helper method to allow scripts to be run taking command line argumentsvoidsetBinding(Binding binding)voidsetProperty(java.lang.String property, java.lang.Object newValue)Sets the given property to the new value.-
Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, setMetaClass
-
-
-
-
Constructor Detail
-
Script
protected Script()
-
Script
protected Script(Binding binding)
-
-
Method Detail
-
getBinding
public Binding getBinding()
-
setBinding
public void setBinding(Binding binding)
-
getProperty
public java.lang.Object getProperty(java.lang.String property)
Description copied from interface:GroovyObjectRetrieves a property value.- Specified by:
getPropertyin interfaceGroovyObject- Overrides:
getPropertyin classGroovyObjectSupport- Parameters:
property- the name of the property of interest- Returns:
- the given property
-
setProperty
public void setProperty(java.lang.String property, java.lang.Object newValue)Description copied from interface:GroovyObjectSets the given property to the new value.- Specified by:
setPropertyin interfaceGroovyObject- Overrides:
setPropertyin classGroovyObjectSupport- Parameters:
property- the name of the property of interestnewValue- the new value for the property
-
invokeMethod
public java.lang.Object invokeMethod(java.lang.String name, java.lang.Object args)Invoke a method (or closure in the binding) defined.- Specified by:
invokeMethodin interfaceGroovyObject- Overrides:
invokeMethodin classGroovyObjectSupport- Parameters:
name- method to callargs- arguments to pass to the method- Returns:
- value
-
run
public abstract java.lang.Object run()
The main instance method of a script which has variables in scope as defined by the currentBindinginstance.
-
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
public void print(java.lang.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. If there is no 'out' property then print to standard out.
-
println
public void println(java.lang.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. If there is no 'out' property then print to standard out.
-
printf
public void printf(java.lang.String format, java.lang.Object value)Prints a formatted string using the specified format string and argument.- Parameters:
format- the format to followvalue- the value to be formatted
-
printf
public void printf(java.lang.String format, java.lang.Object[] values)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
public java.lang.Object evaluate(java.lang.String expression) throws CompilationFailedExceptionA 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
public java.lang.Object evaluate(java.io.File file) throws CompilationFailedException, java.io.IOExceptionA 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:
CompilationFailedExceptionjava.io.IOException
-
run
public void run(java.io.File file, java.lang.String[] arguments) throws CompilationFailedException, java.io.IOExceptionA helper method to allow scripts to be run taking command line arguments- Throws:
CompilationFailedExceptionjava.io.IOException
-
-