move annotations from fdb-extensions to fdb-java-annotations package

Author: alecgrieser

.idea/compiler.xml

@@ -21,13 +21,13 @@
 apply from: rootProject.file('gradle/publishing.gradle')
 
 dependencies {
+    api(project(":fdb-java-annotations")) {
+        exclude(group: "com.squareup", module: "javapoet")
+    }
     api "org.foundationdb:fdb-java:${fdbVersion}"
     implementation "com.google.guava:guava:${guavaVersion}"
     implementation "org.slf4j:slf4j-api:${slf4jVersion}"
-    api "com.squareup:javapoet:${javaPoetVersion}"
     compileOnly "com.google.code.findbugs:jsr305:${jsr305Version}"
-    compileOnly "com.google.auto.service:auto-service:undefined"
-    annotationProcessor "com.google.auto.service:auto-service:undefined"
 
     testCompileOnly "com.google.code.findbugs:jsr305:${jsr305Version}"
     testImplementation "org.junit.jupiter:junit-jupiter-api:${junitVersion}"

.idea/gradle.xml

@@ -0,0 +1,42 @@
+/*
+ * fdb-java-annotations.gradle
+ *
+ * This source file is part of the FoundationDB open source project
+ *
+ * Copyright 2015-2025 Apple Inc. and the FoundationDB project authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+apply from: rootProject.file('gradle/publishing.gradle')
+
+dependencies {
+    // Note: the Java Poet dependency is only really required for annotation processing,
+    // so downstream projects should only require it if they use import this project as
+    // an annotationProcessor dependency (e.g., they use @GenerateVisitor). Ideally,
+    // we'd only include this as a dependency if it's being used in that case, but
+    // barring that, we can exclude it as a transitive dependency when importing
+    implementation "com.squareup:javapoet:${javaPoetVersion}"
+    compileOnly "com.google.auto.service:auto-service:undefined"
+    annotationProcessor "com.google.auto.service:auto-service:undefined"
+}
+
+publishing {
+    publications {
+        library(MavenPublication) {
+            pom {
+                description = 'Common annotations used by FDB related Java projects.'
+            }
+        }
+    }
+}

fdb-extensions/fdb-extensions.gradle

@@ -29,16 +29,22 @@
 /**
  * An annotation used on public types, fields, and methods to indicate their level of stability for consumers of the API.
  *
+ * <p>
  * If a class or interface is annotated with {@code API}, all of its fields and methods are considered to have that same
  * level of stability by default. However, this may be changed by annotating a member explicitly.
+ * </p>
  *
+ * <p>
  * An API may have its stability status become more stable (see {@link Status}) at any time, including before the next
  * minor release. However, an API must not become less stable in the next minor release. Each stability status must
  * specify how API elements with that status may become less stable (e.g., with the next minor release, with next major
  * release).
+ * </p>
  *
+ * <p>
  * The key words "must", "must not", "require", "shall", "shall not", "should", "should not", and "may" in this document
  * are to be interpreted as described in RFC 2119.
+ * </p>
  */
 @Target({ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD})
 @Retention(RetentionPolicy.CLASS)

fdb-java-annotations/fdb-java-annotations.gradle

@@ -23,7 +23,9 @@
 /**
  * Suppress warnings from FindBugs / SpotBugs tools.
  *
+ * <p>
  * Avoids introducing another transitive dependency.
+ * </p>
  */
 @API(API.Status.UNSTABLE)
 public @interface SpotBugsSuppressWarnings {

fdb-extensions/src/main/java/com/apple/foundationdb/annotation/API.java fdb-java-annotations/src/main/java/com/apple/foundationdb/annotation/API.java

@@ -19,7 +19,18 @@
  */
 
 /**
- * Annotations defined for use with FoundationDB. Currently, this only includes the {@link com.apple.foundationdb.annotation.API API}
- * stability annotations, but more could be added in the future.
+ * Annotations defined for use with FoundationDB. Currently, this includes:
+ *
+ * <ul>
+ *     <li> {@link com.apple.foundationdb.annotation.API API} for specifying API stability levels.</li>
+ *     <li> {@link com.apple.foundationdb.annotation.SpotBugsSuppressWarnings SpotBugsSuppressWarnings} for suppressing
+ *         static analysis warnings.</li>
+ *     <li> {@link com.apple.foundationdb.annotation.GenerateVisitor GenerateVisitor} for automatically generating visitor
+ *         interfaces of class hierarchies</li>
+ * </ul>
+ *
+ * <p>
+ * None of the annotations have dependencies on
+ * </p>
  */
 package com.apple.foundationdb.annotation;

fdb-extensions/src/main/java/com/apple/foundationdb/annotation/GenerateVisitor.java fdb-java-annotations/src/main/java/com/apple/foundationdb/annotation/GenerateVisitor.java

@@ -29,8 +29,8 @@ configurations {
 }
 
 dependencies {
+    annotationProcessor project(':fdb-java-annotations')
     api project(':fdb-extensions')
-    annotationProcessor project(':fdb-extensions')
 
     api "com.google.protobuf:protobuf-java:${protobufVersion}"
     implementation "org.slf4j:slf4j-api:${slf4jVersion}"

fdb-extensions/src/main/java/com/apple/foundationdb/annotation/GenerateVisitorAnnotationProcessor.java fdb-java-annotations/src/main/java/com/apple/foundationdb/annotation/GenerateVisitorAnnotationProcessor.java

@@ -53,15 +53,14 @@ buildHost=${InetAddress.getLocalHost().getCanonicalHostName()}
 }
 
 dependencies {
-    api project(':fdb-extensions')
-    annotationProcessor project(':fdb-extensions')
-
+    api(project(':fdb-java-annotations')) {
+        exclude(group: "com.squareup", module: "javapoet")
+    }
     api "com.google.protobuf:protobuf-java:${protobufVersion}"
     compileOnly "com.google.code.findbugs:jsr305:${jsr305Version}"
     implementation "com.google.guava:guava:${guavaVersion}"
 
     testCompileOnly "com.google.code.findbugs:jsr305:${jsr305Version}"
-    testImplementation project(path: ':fdb-extensions', configuration: 'tests')
     testImplementation "org.assertj:assertj-core:${assertjVersion}"
     testImplementation "org.junit.jupiter:junit-jupiter-api:${junitVersion}"
     testImplementation "org.junit.jupiter:junit-jupiter-params:${junitVersion}"

fdb-extensions/src/main/java/com/apple/foundationdb/annotation/SpotBugsSuppressWarnings.java fdb-java-annotations/src/main/java/com/apple/foundationdb/annotation/SpotBugsSuppressWarnings.java

@@ -28,9 +28,6 @@ apply from: rootProject.file('gradle/publishing.gradle')
 
 def coreProject = ":${ext.coreProjectName}"
 dependencies {
-    api project(':fdb-extensions')
-    annotationProcessor project(':fdb-extensions')
-
     implementation(project(coreProject))
     implementation project(":fdb-relational-api")
 
@@ -44,7 +41,6 @@ dependencies {
     implementation("com.github.ben-manes.caffeine:caffeine:${caffeineVersion}")
     implementation("com.github.ben-manes.caffeine:guava:${caffeineVersion}")
 
-    testImplementation project(path: ':fdb-extensions', configuration: 'tests')
     testImplementation project(path: coreProject, configuration: 'tests')
     testImplementation(testFixtures(project(":fdb-relational-api")))
     testImplementation "org.assertj:assertj-core:${assertjVersion}"

fdb-extensions/src/main/java/com/apple/foundationdb/annotation/package-info.java fdb-java-annotations/src/main/java/com/apple/foundationdb/annotation/package-info.java

@@ -82,8 +82,7 @@ publishing {
 
 def coreProject = ":${ext.coreProjectName}"
 dependencies {
-    api project(':fdb-extensions')
-    annotationProcessor project(':fdb-extensions')
+    annotationProcessor project(':fdb-java-annotations')
     // TODO: Why I have to do this when I've included core below..Why is it not
     // transitively included? Is this how gradle works?
     implementation project(coreProject)
@@ -102,8 +101,10 @@ dependencies {
     // Pull in the client for the fixture and httpserver
     def prometheusVersion = '0.16.0'
     implementation "io.prometheus:simpleclient_httpserver:${prometheusVersion}"
+    testFixturesImplementation(project(":fdb-java-annotations")) {
+        exclude(group: "com.squareup", module: "javapoet")
+    }
     testFixturesImplementation "io.prometheus:simpleclient:${prometheusVersion}"
-    testImplementation project(path: ':fdb-extensions', configuration: 'tests')
     testImplementation "io.grpc:grpc-testing:${grpcVersion}"
     implementation "io.dropwizard.metrics:metrics-core:${dropwizardVersion}"
     implementation "com.google.protobuf:protobuf-java:${protobufVersion}"

fdb-record-layer-core/fdb-record-layer-core.gradle

@@ -20,6 +20,7 @@
 
 rootProject.name='fdb-record-layer'
 
+include 'fdb-java-annotations'
 include 'fdb-extensions'
 include 'fdb-record-layer-core'
 include 'fdb-record-layer-core-shaded'