Joda-Beans plugin for Gradle

This project provides a Gradle plugin for Joda-Beans. This is basically a copy of the Joda-Beans Maven Plugin

Tasks

This plugin provides two tasks - jodaValidate and jodaGenerate.

JodaValidate

The jodaValidate task is used to check that no Joda-Beans need regeneration. It can be used from the command line as gradle jodaValidate.

This task has the following optional configuration items:

• indent - as per the command line, the amount of indentation used, either the word "tab", or a number, such as "2" or "4". Default is "4".
• prefix - as per the command line, the prefix used by fields. Default is "".
• verbose - as per the command line, a number from "0" (quiet) to "3" (verbose).
• recursive - whether the source directory should be parsed recursively. Default is "true".
• strict - whether the validate task should fail if beans need regenerating. Default is "false".

JodaGenerate

The jodaGenerate task is used to generate or regenerate any Joda-Beans in the project source directory. It can be used from the command line as gradle jodaGenerate.

This task has the same configuration as the jodaValidate task.

Usage in your gradle build

This section outlines the changes required to your gradle build script.

Dependency

First, declare a dependency to the plugin:

  dependencies {
      ...
      classpath group: 'org.joda', name: 'joda-beans', version: '1.2'
      classpath group: 'org.joda', name: 'joda-beans-plugin', version: '1.0.1'
  }

Configuration

Only the path to the files to process actually is necessary, anything else can be left to the defaults.

If you do need to configure the plugin, your properties might look like this:

  jodabeans {
      sourceDir = file('src/main/java').getAbsolutePath() // the only necessary property
      indent = 4 // this is the default
      verbose = 2
      prefix = "_"
      recursive = true // this is the default
      strict = true
  }