Skip to end of metadata
Go to start of metadata

Getting Started

Setting up your Java environment

Groovy requires Java, so you need to have a version available (while groovy 1.6 supported JDK 1.4 or greater, for groovy 1.7 onwards, minimum JDK 1.5 is needed). Here are the steps if you don't already have Java installed:

  • Get the suitable Java distribution from the website.
  • Run the installer.
  • Set the JAVA_HOME environment variables. On Windows, follow these steps:
    • Open the System control panel
    • Click the Advanced tab
    • Click the Environment Variables button
    • Add a new System variable with the name JAVA_HOME and the value of the directory Java was installed in (mine is C:\Program Files\Java\jdk1.5.0_04)
    • Optionally add %JAVA_HOME%\bin to your system path
      (Note: as an alternative to setting a system environment variable, you can create yourself a '.bat' or '.cmd' file which sets the variable. You then need to run that batch file in any console window in which you wish to run Java and double clicking on '.bat' or '.cmd' files containing Java invocation instructions won't work. If you are unsure about what this means, follow the earlier instructions.)

Setting up your Groovy environment

Download the Groovy installer or binaries from the downloads page and follow the installation instructions.  (There is currently an issue where you cannot have spaces in the path where Groovy is installed under windows.  So, instead of accepting the default installation path of "c:\Program Files\Groovy" you will want to change the path to something like "c:\Groovy")


  • Get a copy of the Groovy distribution from the website, and copy it to some place on your hard drive.
  • Unzip the groovy archive to some logical place on your hard drive, I have mine in C:\dev\groovy-2.0.5
  • Set the GROOVY_HOME environment variables. On Windows, follow these steps:
    • Optionally add a new System variable with the name GROOVY_HOME and the value of the directory groovy was installed in (mine is C:\dev\groovy-2.0.5)
    • Start a command prompt, and type "set" and hit return to see that your environment variables were set correctly.
  • Optionally add %GROOVY_HOME%\bin to your system path
  • Try opening groovyConsole.bat by double clicking on the icon in the bin directory of the Groovy distribution. If it doesn't work, open a command prompt, and change to the bin directory and run it from there to see what the error message is. If it is complaining about not finding parts of Groovy, then setting GROOVY_HOME may help,

Setting up optional jar files

You may wish to obtain optional jar files, either corresponding to Groovy modules (see module documentation for details) or corresponding to other Java classes you wish to make use of from Groovy. Some possibilities are listed below:





Database driver for SQL Server and/or Sybase


Database driver for HSQLDB, a 100% Java database

The recommended way for making Groovy be aware of your additional jar files is to place them in a predefined location. Your Groovy install should include a file called groovy-starter.conf. Within that file, make sure a line such as

is not commented out. The user.home system property is set by your operating system. (Mine is C:\Document and Settings\paul. Now simply place your jar files into the .groovy/lib directory.
(Note: as an alternative, you can set up a CLASSPATH variable and make sure it mentions all of your additional jar files, otherwise Groovy works fine with an empty or no CLASSPATH variable.)

Hello, World

In the top part of the window of the groovyConsole, type the following

And then type <CTRL-R>.
Notice that the text gets printed out in the OS console window (the black one behind the groovyConsole window) and the bottom part of the groovyConsole says:

The line starting with "groovy>" is just the text of what the console processed. The "null" is what the expression "evaluated to". Turns out the expression to print out a message doesn't have any "value" so the groovyConsole printed "null".
Next try something with an actual value. Replace the text in the console with:

or your favorite arithmetic expression, and then type <CTRL-R> (I'm going to stop telling you to hit <CTRL-R>, I think you get the idea). Now the "value" printed at the bottom of the groovyConsole has more meaning.


You can assign values to variables for later use. Try the following:


Lists and Maps

The Groovy language has built-in support for two important data types, lists and maps (Lists can be operated as arrays in Java language). Lists are used to store ordered collections of data. For example an integer list of your favorite integers might look like this:

You can access a given item in the list with square bracket notation (indexes start at 0):

Should result in this output:

You can get the length of the list with the "size" method:

Should print out:

But generally you shouldn't need the length, because unlike Java, the preferred method to loop over all the elements in an list is to use the "each" method, which is described below in the "Code as Data" section.
Another native data structure is called a map. A map is used to store "associative arrays" or "dictionaries". That is unordered collections of heterogeneous, named data. For example, let's say we wanted to store names with IQ scores we might have:

Note that each of the values stored in the map is of a different type. Brett's is an integer, Pete's is a string, and Andrew's is a floating point number. We can access the values in a map in two main ways:

Should produce the output:

To add data to a map, the syntax is similar to adding values to an list. For example, if Pete re-took the IQ test and got a 3, we might:

Then later when we get the value back out, it will be 3.

should print out 3.
Also as an aside, you can create an empty map or an empty list with the following:

To make sure the lists are empty, you can run the following lines:

Should print a size of 0 for the List and the Map.

Conditional Execution

One of the most important features of any programming language is the ability to execute different code under different conditions. The simplest way to do this is to use the '''if''' construct. For example:

Don't worry too much about the first line, it's just some code to determine whether it is currently before noon or after. The rest of the code executes as follows: first it evaluates the expression in the parentheses, then depending on whether the result is '''true''' or '''false''' it executes the first or the second code block. See the section below on boolean expressions.
Note that the "else" block is not required, but the "then" block is:


Boolean Expressions

There is a special data type in most programming languages that is used to represent truth values, '''true''' and '''false'''. The simplest boolean expression are simply those words. Boolean values can be stored in variables, just like any other data type:

A more complex boolean expression uses one of the boolean operators:

Most of those are probably pretty intuitive. The equality operator is '''==''' to distinguish from the assignment operator '''='''. The opposite of equality is the '''!=''' operator, that is "not equal"
So some examples:

Boolean expressions are especially useful when used in conjunction with the '''if''' construct. For example:

An especially useful test is to test whether a variable or expression is null (has no value). For example let's say we want to see whether a given key is in a map:

Generally null is used to indicate the lack of a value in some location.

Debugging and Troubleshooting Tips

  • Print out the class of a variable that you're interested in with myVar.getClass(). Then look up the documentation for that class.
  • If you're having trouble with a complex expression, pare it down to a simpler expression and evaluate that. Then build up to your more complex expression.
  • Try restarting the groovyConsole (this will clear out all the variables so you can start over.
  • Look for the topic you're interested in in the Groovy User Guide

If you are a Java developer

  • No labels


  1. How about including instructions on how to source a script file in GroovyConsole and/or within a script, or at least linking to such instructions.

    • About Getting Started: As long as you run the scripts from the explorer or put the bin-folder into PATH, GROOVY_HOME need not be set. JAVA_HOME however should always be set. Currently the Scripts do not support a JAVA_HOME-Entry with a trailing backward solidus "\" (a notion that is seemingly preferred in recent scripts), but I could provide a patch
    • About Hello, World: The output is no longer output in the shell window as well, but only in the lower half of the split-screen GUI window. Guess nobody needed it. So one could easily patch groovyConsole to run under javaw.exe as well.
    • Regarding Boolean Expressions: The "James Cameron" block only evaluates to a single result, the expression at the bottom. For ease of understand, add a println to each test line (those ending // evaluates to ...)
  2. Groovy allows you to access elements in a Map via its key by using dot operator 


     You can make it work by using println x.(1);// will print out Hello

  3. Hi,

    I think the following: (There is currently an issue where you cannot have spaces in the path where Groovy is installed under windows. So, instead of accepting the default installation path of "c:\Program Files\Groovy" you will want to change the path to something like "c:\Groovy")

    is not relevant anymore as it works just fine for me from "C:\Program Files\Groovy" on Windows XP.

  4. in the 'Hello World' section, you mention something called the GroovyConsole. What is this? How do I get one? You might want to include a section on that first and not make any assumptions.