Fix issues reported by CodeQL (Missing Override annotation)

'Missing Override annotation' was reported 21 times. This commit adds the missing annotations. Signed-off-by: Stefan Weil <[email protected]>
kitodo · Sep 30, 2024 · 2500e63 · 2500e63
1 parent c4ddc1b
commit 2500e63
Show file tree

Hide file tree

Showing 16 changed files with 21 additions and 0 deletions.
diff --git a/Kitodo-API/src/main/java/org/kitodo/utils/JAXBContextCache.java b/Kitodo-API/src/main/java/org/kitodo/utils/JAXBContextCache.java
@@ -118,6 +118,7 @@ private static class ContextDescriptor {
 
         private final String fileName;
 
+        @Override
         public boolean equals(Object potentialContextDescriptor) {
             if (potentialContextDescriptor instanceof ContextDescriptor) {
                 final ContextDescriptor contextDescriptor = ((ContextDescriptor) potentialContextDescriptor);
@@ -127,6 +128,7 @@ public boolean equals(Object potentialContextDescriptor) {
             return false;
         }
 
+        @Override
         public int hashCode() {
             return (clazz + fileName).hashCode();
         }

diff --git a/Kitodo-DataEditor/src/main/java/org/kitodo/dataeditor/MetsKitodoObjectFactory.java b/Kitodo-DataEditor/src/main/java/org/kitodo/dataeditor/MetsKitodoObjectFactory.java
@@ -39,6 +39,7 @@ public class MetsKitodoObjectFactory extends ObjectFactory {
      *
      * @return The KitodoType object.
      */
+    @Override
     public KitodoType createKitodoType() {
         KitodoType kitodoType = super.createKitodoType();
         kitodoType.setVersion(VersionProvider.getDataFormatVersion());

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Property.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Property.java
@@ -264,6 +264,7 @@ public void setWorkpieces(List<Process> workpieces) {
      *            object
      * @return int
      */
+    @Override
     public int compareTo(Property property) {
         int titleMatch = this.getTitle().toLowerCase().compareTo(property.getTitle().toLowerCase());
         int valueMatch = this.getValue().toLowerCase().compareTo(property.getValue().toLowerCase());

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/elasticsearch/KitodoRestClient.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/elasticsearch/KitodoRestClient.java
@@ -131,6 +131,7 @@ private void initiateClientWithAuth(String host, Integer port, String protocol,
      *
      * @return information about the server
      */
+    @Override
     public String getServerInformation() throws IOException {
         Request request = new Request(HttpMethod.GET, "/");
         request.addParameter("pretty", "true");

diff --git a/Kitodo-FileManagement/src/main/java/org/kitodo/filemanagement/FileManagement.java b/Kitodo-FileManagement/src/main/java/org/kitodo/filemanagement/FileManagement.java
@@ -563,6 +563,7 @@ private String getDecodedPath(URI uri) {
         return decodedPath;
     }
 
+    @Override
     public File getFile(URI uri) {
         uri = fileMapper.mapUriToKitodoDataDirectoryUri(uri);
         return new File(uri);

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/ProcessListBaseView.java b/Kitodo/src/main/java/org/kitodo/production/forms/ProcessListBaseView.java
@@ -613,6 +613,7 @@ public void setSelectedProcessesOrProcessDTOs(List<? extends Object> selectedPro
      * Update selection and first row to show in datatable on PageEvent.
      * @param pageEvent PageEvent triggered by data tables paginator
      */
+    @Override
     public void onPageChange(PageEvent pageEvent) {
         this.setFirstRow(((DataTable) pageEvent.getSource()).getFirst());
         if (allSelected) {

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/createprocess/CreateProcessForm.java b/Kitodo/src/main/java/org/kitodo/production/forms/createprocess/CreateProcessForm.java
@@ -713,6 +713,7 @@ public String getReferringView() {
      * @param treeNode treeNode to be added
      * @return whether the given ProcessDetail can be added or not
      */
+    @Override
     public boolean canBeAdded(TreeNode treeNode) throws InvalidMetadataValueException {
         if (Objects.isNull(treeNode.getParent().getParent())) {
             if (Objects.nonNull(currentProcess.getProcessMetadata().getSelectedMetadataTreeNode())
@@ -746,6 +747,7 @@ public boolean canBeDeleted(ProcessDetail processDetail) {
      * @param metadataNode TreeNode for which the check is performed
      * @return whether given TreeNode contains ProcessFieldedMetadata and if any further metadata can be added to it
      */
+    @Override
     public boolean metadataAddableToGroup(TreeNode metadataNode) {
         if (metadataNode.getData() instanceof ProcessFieldedMetadata) {
             return !(DataEditorService.getAddableMetadataForGroup(getMainProcess().getRuleset(), metadataNode).isEmpty());
@@ -757,6 +759,7 @@ public boolean metadataAddableToGroup(TreeNode metadataNode) {
      * Prepare addable metadata for metadata group.
      * @param treeNode metadataGroup treeNode
      */
+    @Override
     public void prepareAddableMetadataForGroup(TreeNode treeNode) {
         addMetadataDialog.prepareAddableMetadataForGroup(getMainProcess().getRuleset(), treeNode);
     }

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/createprocess/ProcessFieldedMetadata.java b/Kitodo/src/main/java/org/kitodo/production/forms/createprocess/ProcessFieldedMetadata.java
@@ -668,6 +668,7 @@ void markLeadingMetadataFields(List<Map<MetadataEntry, Boolean>> leadingMetadata
      *             there is no setter corresponding to the name configured in
      *             the rule set
      */
+    @Override
     public void preserve() throws InvalidMetadataValueException, NoSuchMetadataFieldException {
         try {
             if (Objects.nonNull(division)) {

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/createprocess/ProcessSimpleMetadata.java b/Kitodo/src/main/java/org/kitodo/production/forms/createprocess/ProcessSimpleMetadata.java
@@ -87,6 +87,7 @@ public boolean isUndefined() {
         return Objects.isNull(settings) || settings.isUndefined();
     }
 
+    @Override
     public boolean isRequired() {
         ComplexMetadataViewInterface containerSettings = container.getMetadataView();
         if (!(containerSettings instanceof StructuralElementViewInterface) && container.getChildMetadata().isEmpty()

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/createprocess/ProcessTextMetadata.java b/Kitodo/src/main/java/org/kitodo/production/forms/createprocess/ProcessTextMetadata.java
@@ -84,6 +84,7 @@ public String getInput() {
      * @param skipEmpty boolean
      * @return the metadata from this row
      */
+    @Override
     public Collection<Metadata> getMetadata(boolean skipEmpty) {
         value = value.trim();
         if (skipEmpty && value.isEmpty()) {

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/DataEditorForm.java b/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/DataEditorForm.java
@@ -973,6 +973,7 @@ public String getReferringView() {
      * @param treeNode treeNode to be added
      * @return whether the given ProcessDetail can be added or not
      */
+    @Override
     public boolean canBeAdded(TreeNode treeNode) {
         if (Objects.isNull(treeNode.getParent().getParent())) {
             if (Objects.nonNull(metadataPanel.getSelectedMetadataTreeNode()) || Objects.isNull(addMetadataDialog.getAddableMetadata())) {
@@ -1116,13 +1117,15 @@ public void preserveMetadataPanel() {
      *
      * @return whether given TreeNode contains ProcessFieldedMetadata and if any further metadata can be added to it
      */
+    @Override
     public boolean metadataAddableToGroup(TreeNode metadataNode) {
         return metadataPanel.metadataAddableToGroup(metadataNode);
     }
 
     /**
      * Prepare addable metadata for metadata group.
      */
+    @Override
     public void prepareAddableMetadataForGroup(TreeNode treeNode) {
         addMetadataDialog.prepareAddableMetadataForGroup(treeNode);
     }

diff --git a/Kitodo/src/main/java/org/kitodo/production/services/command/AddDataScript.java b/Kitodo/src/main/java/org/kitodo/production/services/command/AddDataScript.java
@@ -29,6 +29,7 @@ public class AddDataScript extends EditDataScript {
      * @param process the related process
      * @param metadataScript the script to execute
      */
+    @Override
     public void executeScript(LegacyMetsModsDigitalDocumentHelper metadataFile, Process process,
             MetadataScript metadataScript) throws KitodoScriptExecutionException {
         Workpiece workpiece = metadataFile.getWorkpiece();

diff --git a/Kitodo/src/main/java/org/kitodo/production/services/command/DeleteDataScript.java b/Kitodo/src/main/java/org/kitodo/production/services/command/DeleteDataScript.java
@@ -30,6 +30,7 @@ public class DeleteDataScript extends EditDataScript {
      * @param process the related process
      * @param metadataScript the script to execute
      */
+    @Override
     public void executeScript(LegacyMetsModsDigitalDocumentHelper metadataFile, Process process,
                                MetadataScript metadataScript) throws KitodoScriptExecutionException {
         Workpiece workpiece = metadataFile.getWorkpiece();

diff --git a/Kitodo/src/main/java/org/kitodo/production/services/index/IndexingService.java b/Kitodo/src/main/java/org/kitodo/production/services/index/IndexingService.java
@@ -283,6 +283,7 @@ private int getNumberOfDatabaseObjects(ObjectType objectType) throws DAOExceptio
     private ExecutorService createDeamonizedExecutorService(int threads) {
         return Executors.newFixedThreadPool(threads,
             new ThreadFactory() {
+                @Override
                 public Thread newThread(Runnable r) {
                     Thread t = Executors.defaultThreadFactory().newThread(r);
                     t.setDaemon(true);

diff --git a/Kitodo/src/test/java/org/kitodo/selenium/testframework/pages/ProjectsPage.java b/Kitodo/src/test/java/org/kitodo/selenium/testframework/pages/ProjectsPage.java
@@ -195,6 +195,7 @@ public ProjectsPage() {
      *
      * @return The projects page.
      */
+    @Override
     public ProjectsPage goTo() throws Exception {
         Pages.getTopNavigation().gotoProjects();
         await("Wait for execution of link click").pollDelay(Browser.getDelayMinAfterLinkClick(), TimeUnit.MILLISECONDS)

diff --git a/Kitodo/src/test/java/org/kitodo/selenium/testframework/pages/UsersPage.java b/Kitodo/src/test/java/org/kitodo/selenium/testframework/pages/UsersPage.java
@@ -117,6 +117,7 @@ public UsersPage() {
      * 
      * @return The users page.
      */
+    @Override
     public UsersPage goTo() throws Exception {
         Pages.getTopNavigation().gotoUsers();
         await("Wait for execution of link click").pollDelay(Browser.getDelayMinAfterLinkClick(), TimeUnit.MILLISECONDS)