Extremely fast, lightweight annotation scanner for the classpath, classloader, or files for Java 6+
 
 
Go to file
nathan 8194a05c4a updated .gitignore
Updated gradle
2019-05-13 15:16:25 +02:00
gradle/wrapper updated .gitignore 2019-05-13 15:16:25 +02:00
src/dorkbox/annotation Removed dependency on slf4j 2018-08-18 19:55:50 +02:00
.gitignore updated .gitignore 2019-05-13 15:16:25 +02:00
LICENSE Fixed Apachec Software Foundation license name 2018-08-18 23:16:06 +02:00
LICENSE.Apachev2 Initial import of annotations project 2015-02-02 12:54:51 +01:00
LICENSE.MIT Initial import of annotations project 2015-02-02 12:54:51 +01:00
README.md Updated dependencies + info 2019-04-14 17:07:57 +02:00
build.gradle.kts Updated to use Gradle Utils for gradle/project update management 2019-05-13 12:16:06 +02:00
gradlew updated .gitignore 2019-05-13 15:16:25 +02:00
gradlew.bat updated .gitignore 2019-05-13 15:16:25 +02:00
settings.gradle.kts Updated build to kotlin 2019-02-12 12:40:20 +01:00

README.md

Annotations

Dorkbox Github Gitlab Bitbucket

The Annotations project is based on, and almost identical to the excellent infomas AnnotationDetector.

There are major changes to the API to provide for a way to easily extend the scanning functionality, hence it lives here on it's own.

This library can be used to scan (part of) the class path for annotated classes, methods or instance variables. Main advantages of this library compared with similar solutions are: light weight (simple API, 20 kb jar file) and very fast (fastest annotation detection library as far as I know).

The main features of this annotations scanning library:

  • scans the bytecode for annotation information, meaning classes do not have to be loaded by the JVM

  • small footprint

  • extremely fast performance (on moderate hardware, about 200 MB/s)!

  • can scan the classpath, classloader, or specified location

  • uses the SLF4j logging interface

  • simple builder style API

  • lightweight

  • This is for cross-platform use, specifically - linux 32/64, mac 32/64, and windows 32/64. Java 6+

try {
    // Get a list of all classes annotated with @Module, inside the "dorkbox.client" and "dorkbox.common" packages.
    List<Module> classModules = AnnotationDetector.scanClassPath("dorkbox.client", "dorkbox.common")
                                     .forAnnotations(Module.class)  // one or more annotations
                                     .on(ElementType.METHOD) // optional, default ElementType.TYPE. One ore more element types
                                     .filter((File dir, String name) -> !name.endsWith("Client.class")) // optional, default all *.class files
                                     .collect(AnnotationDefaults.getType);
} catch (IOException e) {
    throw new IllegalArgumentException("Unable to start the client", e);
}

   

Maven Info

<dependencies>
    ...
    <dependency>
      <groupId>com.dorkbox</groupId>
      <artifactId>Annotations</artifactId>
      <version>2.14</version>
    </dependency>
</dependencies>

Gradle Info

dependencies {
    ...
    compile "com.dorkbox:Annotations:2.14"
}

Or if you don't want to use Maven, you can access the files directly here:
https://repo1.maven.org/maven2/com/dorkbox/Annotations/

License

This project is © 2011 - 2014, XIAM Solutions B.V. (http://www.xiam.nl) and © 2014 dorkbox llc, and is distributed under the terms of the Apache v2.0 License. See file "LICENSE" for further references.