Use JSpecify

Author: Rakambda

build.gradle.kts

@@ -24,9 +24,9 @@ dependencies {
 
     implementation(libs.picocli)
     implementation(libs.bundles.jackson)
+    implementation(libs.jSpecify)
 
     compileOnly(libs.lombok)
-    compileOnly(libs.jetbrainsAnnotations)
 
     annotationProcessor(libs.lombok)
 
@@ -38,7 +38,6 @@ dependencies {
     testImplementation(libs.bundles.mockito)
 
     testCompileOnly(libs.lombok)
-    testCompileOnly(libs.jetbrainsAnnotations)
 
     testAnnotationProcessor(libs.lombok)
 }

gradle/libs.versions.toml

@@ -3,7 +3,7 @@ slf4j-version = "2.0.17"
 log4j2-version = "2.25.1"
 picocli-version = "4.7.7"
 jackson-version = "2.20.0"
-jetbrains-annotations-version = "26.0.2"
+jspecify-version = "1.0.0"
 metadata-extractor-version = "2.19.0"
 pointlocation6709-version = "4.2.2"
 unirest-version = "4.0.0-RC2"
@@ -26,7 +26,7 @@ jacksonBom = { group = "com.fasterxml.jackson", name = "jackson-bom", version.re
 jackson-core = { group = "com.fasterxml.jackson.core", name = "jackson-core" }
 jackson-annotations = { group = "com.fasterxml.jackson.core", name = "jackson-annotations" }
 jackson-databind = { group = "com.fasterxml.jackson.core", name = "jackson-databind" }
-jetbrainsAnnotations = { group = "org.jetbrains", name = "annotations", version.ref = "jetbrains-annotations-version" }
+jSpecify = { group = "org.jspecify", name = "jspecify", version.ref = "jspecify-version" }
 metadataExtractor = { group = "com.drewnoakes", name = "metadata-extractor", version.ref = "metadata-extractor-version" }
 pointLocation = { group = "us.fatehi", name = "pointlocation6709", version.ref = "pointlocation6709-version" }
 unirest = { group = "com.konghq", name = "unirest-java", version.ref = "unirest-version" }

src/main/java/fr/rakambda/filesecure/config/Configuration.java

@@ -11,7 +11,7 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -30,8 +30,8 @@ public class Configuration{
 	@JsonProperty
 	private List<Rule> rules;
 
-	@NotNull
-	public static Optional<Configuration> loadConfiguration(@NotNull Path path){
+	@NonNull
+	public static Optional<Configuration> loadConfiguration(@NonNull Path path){
 		if(Files.isRegularFile(path)){
 			try(var fis = Files.newBufferedReader(path)){
 				return Optional.ofNullable(objectReader.readValue(fis));

src/main/java/fr/rakambda/filesecure/config/Operation.java

@@ -7,7 +7,7 @@
 import fr.rakambda.filesecure.utils.ThrowingTriConsumer;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 import java.nio.file.Path;
 
 @Getter
@@ -23,7 +23,7 @@ public enum Operation{
 	private final ThrowingTriConsumer<FileOperations, Path, Path> processor;
 
 	@JsonCreator
-	public static Operation getByName(@NotNull String name){
+	public static Operation getByName(@NonNull String name){
 		return valueOf(name);
 	}
 

src/main/java/fr/rakambda/filesecure/config/options/FileTransformer.java

@@ -17,7 +17,7 @@
 import fr.rakambda.filesecure.config.options.file.RenameWithDateTransformer;
 import fr.rakambda.filesecure.exceptions.AbandonBackupException;
 import fr.rakambda.filesecure.processor.FileMetadata;
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 import java.nio.file.Path;
 import java.util.Optional;
 
@@ -38,6 +38,6 @@
 		@JsonSubTypes.Type(value = RenameWithDatePatternTransformer.class, name = "RenameWithDatePatternTransformer"),
 })
 public interface FileTransformer extends Transformer{
-	@NotNull
-	Optional<Path> apply(@NotNull Path sourceFile, @NotNull Path originalOutput, @NotNull Path baseOutput, @NotNull Path currentOutput, @NotNull FileMetadata metadata) throws AbandonBackupException;
+	@NonNull
+	Optional<Path> apply(@NonNull Path sourceFile, @NonNull Path originalOutput, @NonNull Path baseOutput, @NonNull Path currentOutput, @NonNull FileMetadata metadata) throws AbandonBackupException;
 }

src/main/java/fr/rakambda/filesecure/config/options/FolderTransformer.java

@@ -8,7 +8,7 @@
 import fr.rakambda.filesecure.config.options.folder.DeleteIfEmptyTransformer;
 import fr.rakambda.filesecure.config.options.folder.DeleteIfOlderThanTransformer;
 import fr.rakambda.filesecure.utils.FileOperations;
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 import java.nio.file.Path;
 
 @JsonIgnoreProperties(ignoreUnknown = true)
@@ -20,5 +20,5 @@
 		@JsonSubTypes.Type(value = DeleteChildrenTransformer.class, name = "DeleteChildrenTransformer"),
 })
 public interface FolderTransformer extends Transformer{
-	void apply(@NotNull FileOperations fileOperations, @NotNull Path folder, @NotNull Path baseFolder);
+	void apply(@NonNull FileOperations fileOperations, @NonNull Path folder, @NonNull Path baseFolder);
 }

src/main/java/fr/rakambda/filesecure/config/options/Transformer.java

@@ -1,10 +1,10 @@
 package fr.rakambda.filesecure.config.options;
 
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 
 public interface Transformer extends Comparable<Transformer>{
 	@Override
-	default int compareTo(@NotNull Transformer o){
+	default int compareTo(@NonNull Transformer o){
 		return Integer.compare(getPriority(), o.getPriority());
 	}
 

src/main/java/fr/rakambda/filesecure/config/options/file/FolderCanonicalTransformer.java

@@ -10,7 +10,7 @@
 import lombok.AllArgsConstructor;
 import lombok.NoArgsConstructor;
 import lombok.extern.log4j.Log4j2;
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Objects;
@@ -30,17 +30,17 @@ public class FolderCanonicalTransformer implements FileTransformer{
 	@JsonProperty(required = true)
 	private int elementCount = Integer.MAX_VALUE;
 
-	@NotNull
+	@NonNull
 	@Override
-	public Optional<Path> apply(@NotNull Path sourceFile, @NotNull Path originalOutput, @NotNull Path baseOutput, @NotNull Path currentOutput, @NotNull FileMetadata metadata) throws AbandonBackupException{
+	public Optional<Path> apply(@NonNull Path sourceFile, @NonNull Path originalOutput, @NonNull Path baseOutput, @NonNull Path currentOutput, @NonNull FileMetadata metadata) throws AbandonBackupException{
 		var relative = baseOutput.relativize(currentOutput);
 		var base = getBase(relative);
 		var canonical = getCanonicalPath(base.getFileName().toString());
 		return Optional.of(baseOutput.resolve(canonical).resolve(relative));
 	}
 
-	@NotNull
-	private Path getBase(@NotNull Path path){
+	@NonNull
+	private Path getBase(@NonNull Path path){
 		var parent = path.getParent();
 		if(Objects.isNull(parent) || Objects.equals(parent, path)){
 			return path;

src/main/java/fr/rakambda/filesecure/config/options/file/FolderPerDayTransformer.java

@@ -8,7 +8,7 @@
 import fr.rakambda.filesecure.processor.FileMetadata;
 import lombok.NoArgsConstructor;
 import lombok.extern.log4j.Log4j2;
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 import java.nio.file.Path;
 import java.util.Optional;
 
@@ -18,9 +18,9 @@
 @JsonTypeName("FolderPerDayTransformer")
 @NoArgsConstructor
 public class FolderPerDayTransformer implements FileTransformer{
-	@NotNull
+	@NonNull
 	@Override
-	public Optional<Path> apply(@NotNull Path sourceFile, @NotNull Path originalOutput, @NotNull Path baseOutput, @NotNull Path currentOutput, @NotNull FileMetadata metadata) throws AbandonBackupException{
+	public Optional<Path> apply(@NonNull Path sourceFile, @NonNull Path originalOutput, @NonNull Path baseOutput, @NonNull Path currentOutput, @NonNull FileMetadata metadata) throws AbandonBackupException{
 		var date = metadata.getDate();
 		var year = "%4d".formatted(date.getYear());
 		var month = "%02d".formatted(date.getMonthValue());

src/main/java/fr/rakambda/filesecure/config/options/file/FolderPerMonthTransformer.java

@@ -8,7 +8,7 @@
 import fr.rakambda.filesecure.processor.FileMetadata;
 import lombok.NoArgsConstructor;
 import lombok.extern.log4j.Log4j2;
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
 import java.nio.file.Path;
 import java.util.Optional;
 
@@ -18,9 +18,9 @@
 @JsonTypeName("FolderPerMonthTransformer")
 @NoArgsConstructor
 public class FolderPerMonthTransformer implements FileTransformer{
-	@NotNull
+	@NonNull
 	@Override
-	public Optional<Path> apply(@NotNull Path sourceFile, @NotNull Path originalOutput, @NotNull Path baseOutput, @NotNull Path currentOutput, @NotNull FileMetadata metadata) throws AbandonBackupException{
+	public Optional<Path> apply(@NonNull Path sourceFile, @NonNull Path originalOutput, @NonNull Path baseOutput, @NonNull Path currentOutput, @NonNull FileMetadata metadata) throws AbandonBackupException{
 		var date = metadata.getDate();
 		var year = "%4d".formatted(date.getYear());
 		var month = "%02d".formatted(date.getMonthValue());