https://github.com/toolisticon/annotationprocessor-archetype

Maven archetype to create a working project structure to build annotation processors
https://github.com/toolisticon/annotationprocessor-archetype

Last synced: 12 days ago
JSON representation

Maven archetype to create a working project structure to build annotation processors

• Host: GitHub
• URL: https://github.com/toolisticon/annotationprocessor-archetype
• Owner: toolisticon
• License: mit
• Created: 2019-07-19T21:55:32.000Z (almost 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-12T17:21:22.000Z (about 2 years ago)
• Last Synced: 2025-07-27T07:34:34.658Z (11 months ago)
• Language: Java
• Size: 154 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

          
# Toolisticon Annotation Processor Maven Archetype

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.toolisticon.maven.archetypes/annotationprocessor-archetype/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.toolisticon.maven.archetypes/annotationprocessor-archetype)

This project allows you to setup Toolisticon flavoured and maven based annotation processor projects. 

# Why you should use this project?

Project setup can be easily created by using the maven archetype.

It will setup a working annotation processor project including

- api submodule that declares all annotations 

- Annotation processor submodule including unit tests examples

- example submodule

# How does it work?

You just need to create the project by using te following maven command

	mvn archetype:generate \

    	-DarchetypeGroupId=io.toolisticon.maven.archetypes \

    	-DarchetypeArtifactId=annotationprocessor-archetype \

    	-DarchetypeVersion=0.10.0 \

    	-DgroupId= \

    	-DartifactId= \

    	-Dversion= \

    	-Dpackage= \

    	-DannotationName=

    	

Pojo classes you want to create a builder for must be annotated with the Builder annotation.

One hint: some IDEs doesn't work properly with annotation processors.

This is usually caused by incremental builds or insufficient configuration.

A simple workaround is to build from command line inbetween, usually generated classes will be picked up automatically from the target folder afterwards.

# Contributing

We welcome any kind of suggestions and pull requests.

## Building and developing the annotation processor archetype

The archetype is built using Maven.

A simple import of the pom in your IDE should get you up and running. To build the archetype on the commandline, just run `mvn` or `mvn clean install`

## Requirements

The likelihood of a pull request being used rises with the following properties:

- You have used a feature branch.

- You have included a test that demonstrates the functionality added or fixed.

- You adhered to the [code conventions](http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html).

## Contributions

- (2019) Tobias Stamann (Holisticon AG)

# License

This project is released under the revised [MIT License](LICENSE).