Skip to content

Add ant task to modello #606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fridrich wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add ant task to modello #606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 188 additions & 0 deletions modello-ant-task/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
# Modello Ant Task

The `modello-ant-task` is an Apache Ant task that integrates [Codehaus Modello](https://codehaus-plexus.github.io/modello/) into Ant build workflows. It allows you to generate Java classes, XML serializers/deserializers, XML Schemas (XSD), documentation, and other outputs from Modello model description (`.mdo`) files.

---

## Installation & Definition

To use the task in your Ant build file, define it using either the individual task definition or the preferred standard `antlib` resource.

### Option 1: Using Antlib (Recommended)

```xml
<typedef resource="org/codehaus/modello/ant/antlib.xml"
classpathref="modello.classpath" />
```

### Option 2: Using Taskdef

```xml
<taskdef name="modello"
classname="org.codehaus.modello.ant.ModelloTask"
classpathref="modello.classpath" />
```

*Note: `modello.classpath` must contain the `modello-ant-task` JAR, `modello-core`, and any runtime Modello generator plugins you wish to use.*

---

## Task Reference

The `<modello>` task supports several attributes and nested elements to configure code generation.

### Attributes

| Attribute | Type | Description | Required | Default |
|:-------------------------------|:----------|:--------------------------------------------------------------------------------------|:--------:|:---------:|
| **`version`** | `String` | The model version to generate (e.g., `1.0.0`). | **Yes** | — |
| **`outputDirectory`** | `File` | The directory where the generated files will be written. | **Yes** | — |
| **`javaSource`** | `String` | Target Java version for generated source code. | No | `8` |
| **`encoding`** | `String` | Character encoding for generated files. | No | `"utf-8"` |
| **`packageWithVersion`** | `boolean` | Whether to append the version to the package name (`"true"` / `"false"`). | No | `false` |
| **`packagedVersions`** | `String` | Comma-separated list of versions to generate backward compatibility for. | No | — |
| **`domAsXpp3`** | `boolean` | Whether to generate DOM content as Xpp3Dom (`"true"`) or W3C DOM Element (`"false"`). | No | `true` |
| **`licenseFile`** | `File` | Path to file containing license header text to prepend to generated files. | No | — |
| **`licenseText`** | `String` | License header text to prepend to generated files. | No | — |
| **`extendedClassnameSuffix`** | `String` | Suffix for extended class names (e.g., `Ex`). | No | — |
| **`xsdFileName`** | `String` | Custom output file name for generated XSD schema (`xsd` goal). | No | — |
| **`enforceMandatoryElements`** | `boolean` | Whether to enforce mandatory elements in XSD (`"true"` / `"false"`). | No | `false` |
| **`jsonSchemaFileName`** | `String` | Custom output file name for generated JSON Schema (`jsonschema` goal). | No | — |
| **`firstVersion`** | `String` | Earliest version to document when generating documentation (`xdoc` goal). | No | — |
| **`xdocFileName`** | `String` | Custom output file name for generated XDoc documentation (`xdoc` goal). | No | — |
| **`velocityBasedir`** | `File` | Base directory of template files (required only for Velocity-based goals). | No | — |

### Nested Elements

#### `<model>`

Specifies the Modello model description file to read. At least one `<model>` element is required.
* **`file`** (`File`, Required): Path to the `.mdo` model file.

```xml
<model file="src/main/mdo/maven.mdo" />
```

#### `<goal>`

Specifies the Modello generator target to run. At least one `<goal>` element is required.
* **`name`** (`String`, Required): The generator plugin name (e.g., `java`, `xdoc`, `xsd`, `xpp3-reader`, `xpp3-writer`, `velocity`).

```xml
<goal name="java" />
```

#### `<packagedVersion>`

Specifies an additional model version to package. Can be specified multiple times.
* **`name`** (`String`, Required): The version string (e.g., `1.0.0`).

```xml
<packagedVersion name="1.0.0" />
<packagedVersion name="1.1.0" />
```

#### `<license>`

Specifies license header content to prepend to generated sources.
* **`file`** (`File`, Optional): File containing license header text.
* **`text`** (`String`, Optional): Direct license text string (can also be passed as nested text).

```xml
<license file="${basedir}/LICENSE.txt" />
```

#### `<pluralException>`

Specifies an irregular plural mapping used during field naming generation.
* **`name`** (`String`, Required): The plural form (e.g., `aliases`).
* **`value`** (`String`, Required): The singular form (e.g., `alias`).

```xml
<pluralException name="aliases" value="alias" />
```

#### `<template>`

Specifies a custom template file when running the Velocity-based generator (`velocity` goal).
* **`name`** (`String`, Required): Name or path of the template file relative to `velocityBasedir`.

```xml
<template name="model.vm" />
```

#### `<param>`

Specifies custom velocity parameters passed to the generator context.
* **`name`** (`String`, Required): Parameter name.
* **`value`** (`String`, Required): Parameter value.

```xml
<param name="packageModelV4" value="org.example.model" />
```

#### `<property>`

Passes arbitrary Modello parameters directly (equivalent to `-Dkey=value` on the CLI).
* **`name`** (`String`, Required): Parameter key.
* **`value`** (`String`, Required): Parameter value.

```xml
<property name="modello.package.with.version" value="true" />
```

---

## Examples

### Example 1: Standard Code Generation (Java & XSD)

This example generates Java sources and XML Schema definitions (XSD) from a `model.mdo` file into the target folder `target/generated-sources`.

```xml
<target name="generate-model">
<mkdir dir="${basedir}/target/generated-sources" />

<modello version="1.0.0"
outputDirectory="${basedir}/target/generated-sources"
javaSource="11">

<!-- Path to the Modello model -->
<model file="src/main/mdo/model.mdo" />

<!-- Goals to execute -->
<goal name="java" />
<goal name="xsd" />
<goal name="xpp3-reader" />
<goal name="xpp3-writer" />
</modello>
</target>
```

### Example 2: Velocity-Based Generation

This example demonstrates how to use the Velocity generator plugin to create files using a custom `.vm` template.

```xml
<target name="generate-velocity">
<mkdir dir="${basedir}/target/generated-templates" />

<modello version="2.0.0"
outputDirectory="${basedir}/target/generated-templates"
velocityBasedir="${basedir}/src/main/templates">

<model file="src/main/mdo/model.mdo" />

<!-- Execute Velocity generator -->
<goal name="velocity" />

<!-- Template specification -->
<template name="custom-report.vm" />

<!-- Parameters passed to the template context -->
<param name="isMavenModel" value="true" />
<param name="packageModel" value="org.example.api" />
</modello>
</target>
```

156 changes: 156 additions & 0 deletions modello-ant-task/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2026 Fridrich Strba

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello</artifactId>
<version>2.8.2-SNAPSHOT</version>
</parent>

<artifactId>modello-ant-task</artifactId>
<packaging>jar</packaging>

<name>Modello Ant Task</name>
<description>Modello Ant Task enables the use of Modello in Apache Ant builds.</description>

<properties>
<ant.version>1.10.18</ant.version>
</properties>

<dependencies>
<dependency>
<groupId>org.apache.ant</groupId>
<artifactId>ant</artifactId>
<version>${ant.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-core</artifactId>
</dependency>
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-xml</artifactId>
</dependency>

<!-- plugins, sorted alphabetically -->
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-converters</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-dom4j</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-jackson</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-jdom</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-jsonschema</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-sax</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-snakeyaml</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-stax</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-xdoc</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-xpp3</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-xsd</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-xml</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-plugin-velocity</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<configuration>
<archive>
<manifestEntries>
<Automatic-Module-Name>org.codehaus.modello.ant.task</Automatic-Module-Name>
</manifestEntries>
</archive>
</configuration>
</plugin>
</plugins>
</build>

</project>
Loading