Installation

Get started with DomTrip in your Java project using your preferred build tool.

Requirements

  • Java 17 or higher
  • Maven 3.6+ or Gradle 7.0+ (for build tools)

Maven

Core Library

Add DomTrip core to your pom.xml:

<dependency>
    <groupId>eu.maveniverse</groupId>
    <artifactId>domtrip-core</artifactId>
    <version>0.2.0</version>
</dependency>

For Maven POM file editing, use the Maven extension which includes the core library:

<dependency>
    <groupId>eu.maveniverse</groupId>
    <artifactId>domtrip-maven</artifactId>
    <version>0.2.0</version>
</dependency>

The Maven extension provides:

  • PomEditor class with Maven-aware element ordering
  • MavenPomElements constants for type-safe element names
  • Convenience methods for dependencies, plugins, and modules
  • Automatic blank line insertion between element groups

Gradle

Core Library

Add DomTrip core to your build.gradle:

dependencies {
    implementation 'eu.maveniverse:domtrip-core:0.2.0'
}

Maven Extension

For Maven POM editing, use the Maven extension:

dependencies {
    implementation 'eu.maveniverse:domtrip-maven:0.2.0'
}

Or for Kotlin DSL (build.gradle.kts):

dependencies {
    // Core library
    implementation("eu.maveniverse:domtrip-core:0.2.0")

    // Or Maven extension (includes core)
    implementation("eu.maveniverse:domtrip-maven:0.2.0")
}

SBT

Add DomTrip to your build.sbt:

libraryDependencies += "eu.maveniverse" % "domtrip-core" % "0.2.0"

Verify Installation

Create a simple test to verify DomTrip is working:

try {
    String xml = "<project><version>1.0</version></project>";
    Document doc = Document.of(xml);
    Editor editor = new Editor(doc);

    String result = editor.toXml();
    System.out.println("DomTrip is working! Result: " + result);

} catch (Exception e) {
    System.err.println("Error: " + e.getMessage());
}

If you see "✅ DomTrip is working!" and "Round-trip successful: true", you're all set!

IDE Setup

IntelliJ IDEA

  1. Import Project: Open your project in IntelliJ IDEA
  2. Refresh Dependencies: Click the Maven/Gradle refresh button
  3. Enable Auto-Import: Go to Settings → Build Tools → Maven/Gradle → Enable auto-import

Eclipse

  1. Import Project: Import as Maven/Gradle project
  2. Refresh Dependencies: Right-click project → Maven → Reload Projects
  3. Build Path: Verify DomTrip appears in Referenced Libraries

VS Code

  1. Install Extensions: Java Extension Pack, Maven for Java
  2. Open Project: Open the folder containing your project
  3. Reload Window: Ctrl+Shift+P → "Java: Reload Projects"

Snapshot Versions

To use the latest development snapshot versions, add the snapshot repository:

Maven

<repositories>
    <repository>
        <id>sonatype-snapshots</id>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

Gradle

repositories {
    maven {
        url 'https://oss.sonatype.org/content/repositories/snapshots'
    }
}

Next Steps

Now that DomTrip is installed, choose your path:

Core Library

Maven Extension

Troubleshooting

Common Issues

"Package eu.maveniverse.domtrip does not exist"

  • Verify the dependency is correctly added to your build file
  • Check that you're using Java 17 or higher
  • Refresh/reload your project dependencies

"ClassNotFoundException: eu.maveniverse.domtrip.Editor"

  • Ensure the JAR is in your classpath
  • For snapshot versions, verify the snapshot repository is configured

Build fails with "unsupported class file version"

  • DomTrip requires Java 17+. Update your Java version or use a compatible library version

Getting Help