Creating a Groovy Class

Creating a Groovy Class

This tutorial illustrates the XWiki.parseGroovyFromPage API method. This method allow you to instantiate a groovy class from both velocity and groovy code.

Create a groovy class

• Create a new page, for example Groovy.HelloWorldClass containing :

/* Groovy Class #* */

class groovyClass {

def xwiki;
def context;

  void setObjects(xwiki, context) {
    setXWiki(xwiki);
    setContext(context);
  }

  void setXWiki(xwiki) {
    this.xwiki = xwiki;
  }

  void setContext(context) {
    this.context = context;
  }

  String helloWorld() {
    return "Hello World";
  }
}

/* *# */

Notice the trick of putting a Velocity comment in the Groovy comment so that the code is not parsed by Velocity.

Instantiate and use your class from velocity

• Create a new page, for example "Main.HelloWorldFromVelocity" containing :

#set($groovyObject = $xwiki.parseGroovyFromPage("Groovy.HelloWorldClass"))
$groovyObject.setObjects($xwiki, $context)
$groovyObject.helloWorld()

• See the result, feeling groovy ? ;)

Instantiate and use your class from groovy

• Create a new page, for example "Groovy.HelloWorldClass" containing :

<%

groovyObject = xwiki.parseGroovyFromPage("Dev.HelloWorldGroovyClass")
groovyObject.setObjects(xwiki, context)
print(groovyObject.helloWorld())

%>

• See the result, feeling groovy ? ;)