Maven Multi-Module Project¶

my-project/
  pom.xml
  README.md
  core/
    pom.xml
    src/
      main/
        java/
          App.java
          Config.java
        resources/
          application.properties
      test/
        java/
          AppTest.java
        resources/
          test.properties
  web/
    pom.xml
    src/
      main/
        java/
          WebApp.java
          Controller.java
        resources/
          templates/
            index.html
      test/
        java/
          WebAppTest.java

// Root project — contains the parent pom and modules
public interface Project extends S3.Dir {

    @Name("pom.xml")
    PomFile pomXml();

    @Name("README.md")
    ReadmeFile readme();

    // List all modules as directories
    Stream<Module> modules();

    // Jump directly to a module by name
    Module module(String name);
}

// A single module (core, web, etc.)
public interface Module extends S3.Dir {

    @Name("pom.xml")
    PomFile pomXml();

    Src src();

    // Navigate back to the project root
    @Parent
    Project project();
}

// The src/ directory splits into main and test
public interface Src extends S3.Dir {
    Section main();
    Section test();
}

// A section (main or test) contains java and resources
public interface Section extends S3.Dir {
    SourceDir java();
    SourceDir resources();

    // Navigate back to the module (src → module)
    @Parent(2)
    Module module();
}

// A directory of source files
public interface SourceDir extends S3.Dir {
    Stream<SourceFile> sources();
}

// An individual source file
public interface SourceFile extends S3.File {
}

// pom.xml — readable as a string
public interface PomFile extends S3.File {
}

// README.md — readable as a string
public interface ReadmeFile extends S3.File {
}

Project project = bucket.as(Project.class);

project.modules().forEach(module -> {
    System.out.println(module.file().getName());
});
// Output:
//   core
//   web

Module core = project.module("core");

String pom = core.pomXml().getValueAsString();
System.out.println(pom);

Module web = project.module("web");
Section main = web.src().main();

// @Parent(2) jumps from section → src → module
Module parent = main.module();
System.out.println(parent.file().getName());
// Output: web

// From the module, @Parent jumps to the project
Project root = parent.project();
System.out.println(root.readme().getValueAsString());

Module core = project.module("core");

core.src().main().java().sources().forEach(f -> {
    System.out.println(f.file().getAbsoluteName());
});
// Output:
//   my-project/core/src/main/java/App.java
//   my-project/core/src/main/java/Config.java