Merge pull request #301 from lukaskabc/lukaskabc/Refactoring-296

[Ref #296] Replacing nullability annotations with jakarta
kbss-cvut · Sep 23, 2024 · a90c249 · a90c249
2 parents 1526072 + a68b74d
commit a90c249
Show file tree

Hide file tree

Showing 65 changed files with 220 additions and 222 deletions.
diff --git a/src/main/java/cz/cvut/kbss/termit/config/WebSocketMessageBrokerConfig.java b/src/main/java/cz/cvut/kbss/termit/config/WebSocketMessageBrokerConfig.java
@@ -4,12 +4,12 @@
 import cz.cvut.kbss.termit.util.Constants;
 import cz.cvut.kbss.termit.websocket.handler.StompExceptionHandler;
 import cz.cvut.kbss.termit.websocket.handler.WebSocketExceptionHandler;
+import jakarta.annotation.Nonnull;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.Order;
-import org.springframework.lang.NonNull;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.converter.MappingJackson2MessageConverter;
 import org.springframework.messaging.converter.MessageConverter;
@@ -86,7 +86,7 @@ public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentRes
      * @see <a href="https://github.com/spring-projects/spring-security/blob/6.3.x/config/src/main/java/org/springframework/security/config/annotation/web/socket/WebSocketMessageBrokerSecurityConfiguration.java#L97">Spring security source</a>
      */
     @Override
-    public void configureClientInboundChannel(@NonNull ChannelRegistration registration) {
+    public void configureClientInboundChannel(@Nonnull ChannelRegistration registration) {
         AuthorizationChannelInterceptor interceptor = new AuthorizationChannelInterceptor(messageAuthorizationManager);
         interceptor.setAuthorizationEventPublisher(new SpringAuthorizationEventPublisher(context));
         registration.interceptors(webSocketJwtAuthorizationInterceptor, new SecurityContextChannelInterceptor(), interceptor);

diff --git a/src/main/java/cz/cvut/kbss/termit/event/FileTextAnalysisFinishedEvent.java b/src/main/java/cz/cvut/kbss/termit/event/FileTextAnalysisFinishedEvent.java
@@ -1,7 +1,7 @@
 package cz.cvut.kbss.termit.event;
 
 import cz.cvut.kbss.termit.model.resource.File;
-import org.springframework.lang.NonNull;
+import jakarta.annotation.Nonnull;
 
 import java.net.URI;
 
@@ -12,7 +12,7 @@ public class FileTextAnalysisFinishedEvent extends VocabularyEvent {
 
     private final URI fileUri;
 
-    public FileTextAnalysisFinishedEvent(Object source, @NonNull File file) {
+    public FileTextAnalysisFinishedEvent(Object source, @Nonnull File file) {
         super(source, file.getDocument().getVocabulary());
         this.fileUri = file.getUri();
     }

diff --git a/src/main/java/cz/cvut/kbss/termit/event/LongRunningTaskChangedEvent.java b/src/main/java/cz/cvut/kbss/termit/event/LongRunningTaskChangedEvent.java
@@ -1,8 +1,8 @@
 package cz.cvut.kbss.termit.event;
 
 import cz.cvut.kbss.termit.util.longrunning.LongRunningTaskStatus;
+import jakarta.annotation.Nonnull;
 import org.springframework.context.ApplicationEvent;
-import org.springframework.lang.NonNull;
 
 /**
  * Indicates a status change of a long-running task.
@@ -11,12 +11,12 @@ public class LongRunningTaskChangedEvent extends ApplicationEvent {
 
     private final LongRunningTaskStatus status;
 
-    public LongRunningTaskChangedEvent(@NonNull Object source, final @NonNull LongRunningTaskStatus status) {
+    public LongRunningTaskChangedEvent(@Nonnull Object source, final @Nonnull LongRunningTaskStatus status) {
         super(source);
         this.status = status;
     }
 
-    public @NonNull LongRunningTaskStatus getStatus() {
+    public @Nonnull LongRunningTaskStatus getStatus() {
         return status;
     }
 }
diff --git a/src/main/java/cz/cvut/kbss/termit/event/TermDefinitionTextAnalysisFinishedEvent.java b/src/main/java/cz/cvut/kbss/termit/event/TermDefinitionTextAnalysisFinishedEvent.java
@@ -1,7 +1,7 @@
 package cz.cvut.kbss.termit.event;
 
 import cz.cvut.kbss.termit.model.AbstractTerm;
-import org.springframework.lang.NonNull;
+import jakarta.annotation.Nonnull;
 
 import java.net.URI;
 
@@ -11,7 +11,7 @@
 public class TermDefinitionTextAnalysisFinishedEvent extends VocabularyEvent {
     private final URI termUri;
 
-    public TermDefinitionTextAnalysisFinishedEvent(@NonNull Object source, @NonNull AbstractTerm term) {
+    public TermDefinitionTextAnalysisFinishedEvent(@Nonnull Object source, @Nonnull AbstractTerm term) {
         super(source, term.getVocabulary());
         this.termUri = term.getUri();
     }

diff --git a/src/main/java/cz/cvut/kbss/termit/event/VocabularyContentModifiedEvent.java b/src/main/java/cz/cvut/kbss/termit/event/VocabularyContentModifiedEvent.java
@@ -17,7 +17,7 @@
  */
 package cz.cvut.kbss.termit.event;
 
-import org.springframework.lang.NonNull;
+import jakarta.annotation.Nonnull;
 
 import java.net.URI;
 
@@ -28,7 +28,7 @@
  */
 public class VocabularyContentModifiedEvent extends VocabularyEvent {
 
-    public VocabularyContentModifiedEvent(@NonNull Object source, @NonNull URI vocabularyIri) {
+    public VocabularyContentModifiedEvent(@Nonnull Object source, @Nonnull URI vocabularyIri) {
         super(source, vocabularyIri);
     }
 }
diff --git a/src/main/java/cz/cvut/kbss/termit/event/VocabularyCreatedEvent.java b/src/main/java/cz/cvut/kbss/termit/event/VocabularyCreatedEvent.java
@@ -17,7 +17,7 @@
  */
 package cz.cvut.kbss.termit.event;
 
-import org.springframework.lang.NonNull;
+import jakarta.annotation.Nonnull;
 
 import java.net.URI;
 
@@ -26,7 +26,7 @@
  */
 public class VocabularyCreatedEvent extends VocabularyEvent {
 
-    public VocabularyCreatedEvent(@NonNull Object source, @NonNull URI vocabularyIri) {
+    public VocabularyCreatedEvent(@Nonnull Object source, @Nonnull URI vocabularyIri) {
         super(source, vocabularyIri);
     }
 }
diff --git a/src/main/java/cz/cvut/kbss/termit/event/VocabularyEvent.java b/src/main/java/cz/cvut/kbss/termit/event/VocabularyEvent.java
@@ -1,7 +1,7 @@
 package cz.cvut.kbss.termit.event;
 
+import jakarta.annotation.Nonnull;
 import org.springframework.context.ApplicationEvent;
-import org.springframework.lang.NonNull;
 
 import java.net.URI;
 import java.util.Objects;
@@ -12,7 +12,7 @@
 public abstract class VocabularyEvent extends ApplicationEvent {
     protected final URI vocabularyIri;
 
-    protected VocabularyEvent(@NonNull Object source, @NonNull URI vocabularyIri) {
+    protected VocabularyEvent(@Nonnull Object source, @Nonnull URI vocabularyIri) {
         super(source);
         Objects.requireNonNull(vocabularyIri);
         this.vocabularyIri = vocabularyIri;

diff --git a/src/main/java/cz/cvut/kbss/termit/event/VocabularyValidationFinishedEvent.java b/src/main/java/cz/cvut/kbss/termit/event/VocabularyValidationFinishedEvent.java
@@ -1,7 +1,7 @@
 package cz.cvut.kbss.termit.event;
 
 import cz.cvut.kbss.termit.model.validation.ValidationResult;
-import org.springframework.lang.NonNull;
+import jakarta.annotation.Nonnull;
 
 import java.net.URI;
 import java.util.ArrayList;
@@ -28,21 +28,21 @@ public class VocabularyValidationFinishedEvent extends VocabularyEvent {
      * @param vocabularyIris IRI of the vocabulary on which the validation was triggered.
      * @param validationResults results of the validation
      */
-    public VocabularyValidationFinishedEvent(@NonNull Object source, @NonNull URI originVocabularyIri,
-                                             @NonNull Collection<URI> vocabularyIris,
-                                             @NonNull List<ValidationResult> validationResults) {
+    public VocabularyValidationFinishedEvent(@Nonnull Object source, @Nonnull URI originVocabularyIri,
+                                             @Nonnull Collection<URI> vocabularyIris,
+                                             @Nonnull List<ValidationResult> validationResults) {
         super(source, originVocabularyIri);
         // defensive copy
         this.vocabularyIris = new ArrayList<>(vocabularyIris);
         this.validationResults = new ArrayList<>(validationResults);
     }
 
-    @NonNull
+    @Nonnull
     public List<URI> getVocabularyIris() {
         return Collections.unmodifiableList(vocabularyIris);
     }
 
-    @NonNull
+    @Nonnull
     public List<ValidationResult> getValidationResults() {
         return Collections.unmodifiableList(validationResults);
     }

diff --git a/src/main/java/cz/cvut/kbss/termit/event/VocabularyWillBeRemovedEvent.java b/src/main/java/cz/cvut/kbss/termit/event/VocabularyWillBeRemovedEvent.java
@@ -1,6 +1,6 @@
 package cz.cvut.kbss.termit.event;
 
-import org.springframework.lang.NonNull;
+import jakarta.annotation.Nonnull;
 
 import java.net.URI;
 
@@ -9,7 +9,7 @@
  */
 public class VocabularyWillBeRemovedEvent extends VocabularyEvent {
 
-    public VocabularyWillBeRemovedEvent(@NonNull Object source, @NonNull URI vocabularyIri) {
+    public VocabularyWillBeRemovedEvent(@Nonnull Object source, @Nonnull URI vocabularyIri) {
         super(source, vocabularyIri);
     }
 }
diff --git a/src/main/java/cz/cvut/kbss/termit/exception/TermItException.java b/src/main/java/cz/cvut/kbss/termit/exception/TermItException.java
@@ -18,8 +18,8 @@
 package cz.cvut.kbss.termit.exception;
 
 import cz.cvut.kbss.termit.util.Utils;
-import org.springframework.lang.NonNull;
-import org.springframework.lang.Nullable;
+import jakarta.annotation.Nonnull;
+import jakarta.annotation.Nullable;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -72,18 +72,18 @@ public TermItException(String message, Throwable cause, String messageId) {
         this.messageId = messageId;
     }
 
-    public TermItException(String message, Throwable cause, String messageId, @NonNull Map<String, String> parameters) {
+    public TermItException(String message, Throwable cause, String messageId, @Nonnull Map<String, String> parameters) {
         super(message, cause);
         this.messageId = messageId;
         addParameters(parameters);
     }
 
-    public TermItException addParameters(@NonNull Map<String, String> parameters) {
+    public TermItException addParameters(@Nonnull Map<String, String> parameters) {
         this.parameters.putAll(parameters);
         return this;
     }
 
-    public TermItException addParameter(@NonNull String key, @NonNull String value) {
+    public TermItException addParameter(@Nonnull String key, @Nonnull String value) {
         this.parameters.put(key, value);
         return this;
     }

diff --git a/src/main/java/cz/cvut/kbss/termit/persistence/dao/BaseDao.java b/src/main/java/cz/cvut/kbss/termit/persistence/dao/BaseDao.java
@@ -25,7 +25,7 @@
 import cz.cvut.kbss.termit.exception.PersistenceException;
 import cz.cvut.kbss.termit.model.util.EntityToOwlClassMapper;
 import cz.cvut.kbss.termit.model.util.HasIdentifier;
-import org.jetbrains.annotations.NotNull;
+import jakarta.annotation.Nonnull;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.ApplicationEventPublisherAware;
 
@@ -159,7 +159,7 @@ protected Descriptor getDescriptor() {
     }
 
     @Override
-    public void setApplicationEventPublisher(@NotNull ApplicationEventPublisher eventPublisher) {
+    public void setApplicationEventPublisher(@Nonnull ApplicationEventPublisher eventPublisher) {
         this.eventPublisher = eventPublisher;
     }
 }
diff --git a/src/main/java/cz/cvut/kbss/termit/persistence/dao/SearchDao.java b/src/main/java/cz/cvut/kbss/termit/persistence/dao/SearchDao.java
@@ -26,13 +26,13 @@
 import cz.cvut.kbss.termit.util.Configuration;
 import cz.cvut.kbss.termit.util.Utils;
 import cz.cvut.kbss.termit.util.Vocabulary;
+import jakarta.annotation.Nonnull;
 import jakarta.annotation.PostConstruct;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Profile;
 import org.springframework.data.domain.Pageable;
-import org.springframework.lang.NonNull;
 import org.springframework.stereotype.Repository;
 
 import java.net.URI;
@@ -79,7 +79,7 @@ private void loadQueries() {
      * @return List of matching results
      * @see #fullTextSearchIncludingSnapshots(String)
      */
-    public List<FullTextSearchResult> fullTextSearch(@NonNull String searchString) {
+    public List<FullTextSearchResult> fullTextSearch(@Nonnull String searchString) {
         Objects.requireNonNull(searchString);
         if (searchString.isBlank()) {
             return Collections.emptyList();
@@ -102,7 +102,7 @@ public List<FullTextSearchResult> fullTextSearch(@NonNull String searchString) {
      * @return List of matching results
      * @see #fullTextSearchIncludingSnapshots(String)
      */
-    public List<FullTextSearchResult> fullTextSearchIncludingSnapshots(@NonNull String searchString) {
+    public List<FullTextSearchResult> fullTextSearchIncludingSnapshots(@Nonnull String searchString) {
         Objects.requireNonNull(searchString);
         if (searchString.isBlank()) {
             return Collections.emptyList();
@@ -136,8 +136,8 @@ protected String queryIncludingSnapshots() {
      * @param pageSpec     Specification of the page of results to return
      * @return List of matching terms, ordered by label
      */
-    public List<FacetedSearchResult> facetedTermSearch(@NonNull Collection<SearchParam> searchParams,
-                                                       @NonNull Pageable pageSpec) {
+    public List<FacetedSearchResult> facetedTermSearch(@Nonnull Collection<SearchParam> searchParams,
+                                                       @Nonnull Pageable pageSpec) {
         Objects.requireNonNull(searchParams);
         Objects.requireNonNull(pageSpec);
         LOG.trace("Running faceted term search for search parameters: {}", searchParams);

diff --git a/src/main/java/cz/cvut/kbss/termit/persistence/dao/acl/AccessControlListDao.java b/src/main/java/cz/cvut/kbss/termit/persistence/dao/acl/AccessControlListDao.java
@@ -29,7 +29,7 @@
 import cz.cvut.kbss.termit.persistence.context.DescriptorFactory;
 import cz.cvut.kbss.termit.util.Utils;
 import cz.cvut.kbss.termit.util.Vocabulary;
-import org.springframework.lang.NonNull;
+import jakarta.annotation.Nonnull;
 import org.springframework.stereotype.Repository;
 
 import java.net.URI;
@@ -170,7 +170,7 @@ public Optional<URI> resolveSubjectOf(AccessControlList acl) {
      * @param agent Agent whose access is examined
      * @return List of matching assets
      */
-    public List<? extends Asset<?>> findAssetsByAgentWithSecurityAccess(@NonNull AccessControlAgent agent) {
+    public List<? extends Asset<?>> findAssetsByAgentWithSecurityAccess(@Nonnull AccessControlAgent agent) {
         Objects.requireNonNull(agent);
         return em.createNativeQuery("SELECT ?a WHERE { " +
                                             "?a a ?type ; " +

diff --git a/src/main/java/cz/cvut/kbss/termit/persistence/dao/lucene/LuceneSearchDao.java b/src/main/java/cz/cvut/kbss/termit/persistence/dao/lucene/LuceneSearchDao.java
@@ -22,10 +22,10 @@
 import cz.cvut.kbss.termit.persistence.dao.SearchDao;
 import cz.cvut.kbss.termit.util.Configuration;
 import cz.cvut.kbss.termit.util.Vocabulary;
+import jakarta.annotation.Nonnull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.context.annotation.Profile;
-import org.springframework.lang.NonNull;
 import org.springframework.stereotype.Repository;
 
 import java.net.URI;
@@ -53,7 +53,7 @@ public LuceneSearchDao(EntityManager em, Configuration config) {
     }
 
     @Override
-    public List<FullTextSearchResult> fullTextSearch(@NonNull String searchString) {
+    public List<FullTextSearchResult> fullTextSearch(@Nonnull String searchString) {
         Objects.requireNonNull(searchString);
         if (searchString.isBlank()) {
             return Collections.emptyList();
@@ -87,7 +87,7 @@ private static String splitExactMatch(String searchString) {
     }
 
     @Override
-    public List<FullTextSearchResult> fullTextSearchIncludingSnapshots(@NonNull String searchString) {
+    public List<FullTextSearchResult> fullTextSearchIncludingSnapshots(@Nonnull String searchString) {
         Objects.requireNonNull(searchString);
         if (searchString.isBlank()) {
             return Collections.emptyList();

diff --git a/src/main/java/cz/cvut/kbss/termit/persistence/validation/ResultCachingValidator.java b/src/main/java/cz/cvut/kbss/termit/persistence/validation/ResultCachingValidator.java
@@ -25,13 +25,13 @@
 import cz.cvut.kbss.termit.model.validation.ValidationResult;
 import cz.cvut.kbss.termit.util.throttle.Throttle;
 import cz.cvut.kbss.termit.util.throttle.ThrottledFuture;
+import jakarta.annotation.Nonnull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Lookup;
 import org.springframework.context.annotation.Primary;
 import org.springframework.context.annotation.Profile;
 import org.springframework.context.event.EventListener;
-import org.springframework.lang.NonNull;
 import org.springframework.stereotype.Component;
 import org.springframework.transaction.annotation.Transactional;
 
@@ -64,11 +64,11 @@ public class ResultCachingValidator implements VocabularyContentValidator {
     /**
      * @return true when the cache contents are dirty and should be refreshed; false otherwise.
      */
-    public boolean isNotDirty(@NonNull URI originVocabularyIri) {
+    public boolean isNotDirty(@Nonnull URI originVocabularyIri) {
         return vocabularyClosure.containsKey(originVocabularyIri);
     }
 
-    private Optional<Collection<ValidationResult>> getCached(@NonNull URI originVocabularyIri) {
+    private Optional<Collection<ValidationResult>> getCached(@Nonnull URI originVocabularyIri) {
         synchronized (validationCache) {
             return Optional.ofNullable(validationCache.get(originVocabularyIri));
         }
@@ -77,8 +77,8 @@ private Optional<Collection<ValidationResult>> getCached(@NonNull URI originVoca
     @Throttle(value = "{#originVocabularyIri}", name="vocabularyValidation")
     @Transactional
     @Override
-    @NonNull
-    public ThrottledFuture<Collection<ValidationResult>> validate(@NonNull URI originVocabularyIri, @NonNull Collection<URI> vocabularyIris) {
+    @Nonnull
+    public ThrottledFuture<Collection<ValidationResult>> validate(@Nonnull URI originVocabularyIri, @Nonnull Collection<URI> vocabularyIris) {
         final Set<URI> iris = Set.copyOf(vocabularyIris);
 
         if (iris.isEmpty()) {
@@ -94,8 +94,8 @@ public ThrottledFuture<Collection<ValidationResult>> validate(@NonNull URI origi
         return ThrottledFuture.of(() -> runValidation(originVocabularyIri, iris)).setCachedResult(cached.orElse(null));
     }
 
-    @NonNull
-    private Collection<ValidationResult> runValidation(@NonNull URI originVocabularyIri, @NonNull final Set<URI> iris) {
+    @Nonnull
+    private Collection<ValidationResult> runValidation(@Nonnull URI originVocabularyIri, @Nonnull final Set<URI> iris) {
         Optional<Collection<ValidationResult>> cached = getCached(originVocabularyIri);
         if (isNotDirty(originVocabularyIri) && cached.isPresent()) {
             return cached.get();