Variable annotation used for changing the base script class of the current script.

The type of the variable annotated with @BaseScript must extend Script. It will be used as the base script class. The annotated variable will become shortcut to this object. Using this annotation will override base script set by Groovy compiler or CompilerConfiguration of GroovyShell Example usage:

 class CustomScript extends Script {
     int getTheMeaningOfLife() { 42 }
 }

 @BaseScript CustomScript baseScript

 assert baseScript == this
 assert theMeaningOfLife == 42
 assert theMeaningOfLife == baseScript.theMeaningOfLife
 

The custom base script may implement the run() method and specify a different method name to be used for the script body by declaring a single abstract method. For example:

 abstract class CustomScriptBodyMethod extends Script {
     abstract def runScript()
     def preRun() { println "preRunning" }
     def postRun() { println "postRunning" }
     def run() {
         preRun()
         try {
             3.times { runScript() }
         } finally {
             postRun()
         }
     }
 }

 @BaseScript CustomScriptBodyMethod baseScript
 println "Script body run"
 

 preRunning
 Script body run
 Script body run
 Script body run
 postRunning
 

Authors:

Paul King

Vladimir Orany

Jim White

Since:

2.2.0