Overarch Java provides an annotation processor for the java compiler to generate Overarch models from java sources.
draft
Currently leiningen is used to build the overarch-java.jar
.
For a local build and installation in the maven repository use
lein install
Add the overarch-java
and overarch-java-annotations
dependencies to your project
and annotate your java sources with the overarch annotations.
On compilation, the annotation processor processes the annotated source files
and generates a model.edn
file containing the set of model elements derived
from the sources.
Create a component model element by annotating a package in the package-info.java
file:
/**
* The User Management component provides the user related functionality.
*/
@OverarchNode(el = "component", id = "example/user", name = "User Management")
package example.user;
import org.soulspace.overarch.java.OverarchNode;
Create a component model element by annotating a class:
package example.user.application;
import java.util.UUID;
import org.soulspace.overarch.java.OverarchNode;
import example.user.domain.User;
/**
* Implements the use cases of the user management component
*/
@OverarchNode(el = "class" , id = "example.user.application/user-service")
public class UserService {
public User createUser(String firstname, String lastName, String email) {
// TODO implement
return null;
};
public boolean deleteUser(UUID id) {
// TODO implement
return false;
};
}
© 2024 Ludger Solbach
Eclipse Public License 1.0 (EPL1.0)
Can you improve this documentation?Edit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close