Skip to content

Adopt jspecify + NullAway null-checking on fdb-java-annotations #4576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
arnaud-lacurie wants to merge 1 commit into from
Draft

Adopt jspecify + NullAway null-checking on fdb-java-annotations #4576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions fdb-java-annotations/fdb-java-annotations.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
* limitations under the License.
*/

plugins {
alias(libs.plugins.errorprone)
}

apply from: rootProject.file('gradle/publishing.gradle')

dependencies {
Expand All @@ -28,7 +32,23 @@ dependencies {
// barring that, we can exclude it as a transitive dependency when importing
implementation(libs.javaPoet)
compileOnly(libs.autoService)
compileOnly(libs.jspecify)
annotationProcessor(libs.autoService)

errorprone(libs.errorprone.core)
errorprone(libs.nullaway)
}

// jspecify + NullAway, scoped to this module only. See @NullMarked package-info.java in
// com.apple.foundationdb.annotation.
tasks.withType(JavaCompile).configureEach {
options.errorprone {
disableAllChecks = true
error("NullAway")
option("NullAway:AnnotatedPackages", "com.apple.foundationdb.annotation")
option("NullAway:JSpecifyMode", "true")
option("NullAway:AcknowledgeRestrictiveAnnotations", "true")
}
}

publishing {
Expand Down
50 changes: 25 additions & 25 deletions ...ions/src/main/java/com/apple/foundationdb/annotation/GenerateVisitorAnnotationHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,12 @@ static boolean process(final ProcessingEnvironment processingEnv, Set<? extends
return true;
}

private static void generateCode(@Nonnull final Types typeUtils,
@Nonnull final Filer filer,
@Nonnull GenerateVisitor generateVisitor,
@Nonnull final PackageElement packageElement,
@Nonnull final TypeElement rootTypeElement,
@Nonnull final List<TypeMirror> subClassTypeMirrors) throws IOException {
private static void generateCode(final Types typeUtils,
final Filer filer,
GenerateVisitor generateVisitor,
final PackageElement packageElement,
final TypeElement rootTypeElement,
final List<TypeMirror> subClassTypeMirrors) throws IOException {
final var rootTypeMirror = rootTypeElement.asType();
final var interfaceName = rootTypeElement.getSimpleName() + generateVisitor.classSuffix();
final var typeVariableName = TypeVariableName.get("T");
Expand All @@ -138,15 +138,15 @@ private static void generateCode(@Nonnull final Types typeUtils,
generateImplementationWithDefaults(typeUtils, filer, generateVisitor, packageElement, subClassTypeMirrors, className, interfaceName, typeVariableName, defaultMethodName);
}

private static void generateInterface(@Nonnull final Types typeUtils,
@Nonnull final Filer filer,
@Nonnull final GenerateVisitor generateVisitor,
@Nonnull final PackageElement packageElement,
@Nonnull final List<TypeMirror> subClassTypeMirrors,
@Nonnull final TypeMirror rootTypeMirror,
@Nonnull final String interfaceName,
@Nonnull final TypeVariableName typeVariableName,
@Nonnull final String defaultMethodName) throws IOException {
private static void generateInterface(final Types typeUtils,
final Filer filer,
final GenerateVisitor generateVisitor,
final PackageElement packageElement,
final List<TypeMirror> subClassTypeMirrors,
final TypeMirror rootTypeMirror,
final String interfaceName,
final TypeVariableName typeVariableName,
final String defaultMethodName) throws IOException {
final TypeSpec.Builder typeBuilder =
TypeSpec.interfaceBuilder(interfaceName)
.addModifiers(Modifier.PUBLIC)
Expand Down Expand Up @@ -216,15 +216,15 @@ private static void generateInterface(@Nonnull final Types typeUtils,
.writeTo(Objects.requireNonNull(filer));
}

private static void generateImplementationWithDefaults(@Nonnull final Types typeUtils,
@Nonnull final Filer filer,
@Nonnull final GenerateVisitor generateVisitor,
@Nonnull final PackageElement packageElement,
@Nonnull final List<TypeMirror> subClassTypeMirrors,
@Nonnull final String className,
@Nonnull final String interfaceName,
@Nonnull final TypeVariableName typeVariableName,
@Nonnull final String defaultMethodName) throws IOException {
private static void generateImplementationWithDefaults(final Types typeUtils,
final Filer filer,
final GenerateVisitor generateVisitor,
final PackageElement packageElement,
final List<TypeMirror> subClassTypeMirrors,
final String className,
final String interfaceName,
final TypeVariableName typeVariableName,
final String defaultMethodName) throws IOException {
final TypeSpec.Builder typeBuilder =
TypeSpec.interfaceBuilder(className)
.addModifiers(Modifier.PUBLIC)
Expand Down Expand Up @@ -254,7 +254,7 @@ private static void generateImplementationWithDefaults(@Nonnull final Types type
.writeTo(Objects.requireNonNull(filer));
}

private static String methodNameOfVisitMethod(@Nonnull final GenerateVisitor generateVisitor, @Nonnull TypeElement typeElement) {
private static String methodNameOfVisitMethod(final GenerateVisitor generateVisitor, TypeElement typeElement) {
return generateVisitor.methodPrefix() + typeElement.getSimpleName().toString().replace(generateVisitor.stripPrefix(), "");
}

Expand Down
4 changes: 1 addition & 3 deletions ...s/src/main/java/com/apple/foundationdb/annotation/GenerateVisitorAnnotationProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@

import com.google.auto.service.AutoService;

import javax.annotation.Nonnull;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
Expand Down Expand Up @@ -78,11 +77,10 @@
@AutoService(Processor.class)
public class GenerateVisitorAnnotationProcessor extends AbstractProcessor {
@Override
public synchronized void init(@Nonnull final ProcessingEnvironment processingEnv) {
public synchronized void init(final ProcessingEnvironment processingEnv) {
super.init(processingEnv);
}

@Nonnull
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
Expand Down
3 changes: 3 additions & 0 deletions fdb-java-annotations/src/main/java/com/apple/foundationdb/annotation/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,7 @@
* None of the annotations have dependencies on
* </p>
*/
@NullMarked
package com.apple.foundationdb.annotation;

import org.jspecify.annotations.NullMarked;
Loading