README.md
1# Auto Common Utilities
2
3## Overview
4
5The Auto project has a set of common utilities to help ease use of the
6annotation processing environment.
7
8## Utility classes of note
9
10* MoreTypes - utilities and Equivalence wrappers for TypeMirror and related
11 subtypes
12* MoreElements - utilities for Element and related subtypes
13* SuperficialValidation - very simple scanner to ensure an Element is valid
14 and free from distortion from upstream compilation errors
15* Visibility - utilities for working with Elements' visibility levels (public,
16 protected, etc.)
17* BasicAnnotationProcessor/ProcessingStep - simple types that
18 - implement a validating annotation processor
19 - defer invalid elements until later
20 - break processor actions into multiple steps (which may each handle
21 different annotations)
22
23## Usage/Setup
24
25Auto common utilities have a standard [Maven](http://maven.apache.org) setup
26which can also be used from Gradle, Ivy, Ant, or other systems which consume
27binary artifacts from the central Maven binary artifact repositories.
28
29```xml
30<dependency>
31 <groupId>com.google.auto</groupId>
32 <artifactId>auto-common</artifactId>
33 <version>1.0-SNAPSHOT</version> <!-- or use a known release version -->
34</dependency>
35```
36