search

JetBrains / java-annotations

Annotations for JVM-based languages.
Apache License 2.0
407 stars 47 forks source link

readme

Annotations for JVM-based languages

official JetBrains project License Maven Central javadoc

A set of Java annotations which can be used in JVM-based languages. They serve as an additional documentation and can be interpreted by IDEs and static analysis tools to improve code analysis.

Change Log | Contributing | Code of Conduct

Documentation

Using the annotations

The annotations are published on Maven Central. To add a dependency using gradle write the following in the build.gradle file (Groovy DSL)

dependencies {
    compileOnly 'org.jetbrains:annotations:26.0.1'
}

or in the build.gradle.kts file (Kotlin DSL)

dependencies {
    compileOnly("org.jetbrains:annotations:26.0.1")
}

To add a dependency using Maven, write the following in pom.xml:

<dependency>
  <groupId>org.jetbrains</groupId>
  <artifactId>annotations</artifactId>
  <version>26.0.1</version>
  <scope>provided</scope>
</dependency>

annotations artifact requires JDK 1.8 or higher. If your project is compiled using JDK 1.5, 1.6 or 1.7 you can use the annotations-java5 artifact instead. Please note that annotations-java5 artifact is considered a legacy and will receive no further updates. The latest version of annotations-java5 is 24.1.0.