Add static analysis tools

Author: pcastornii

patternfx-core/pom.xml

@@ -18,6 +18,10 @@
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.techsenger.annotations</groupId>
+            <artifactId>annotations</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.techsenger.toolkit</groupId>
             <artifactId>toolkit-fx</artifactId>

patternfx-core/src/main/java/com/techsenger/patternfx/core/AbstractBreadthFirstIterator.java

@@ -16,7 +16,7 @@
 
 package com.techsenger.patternfx.core;
 
-import java.util.LinkedList;
+import java.util.ArrayDeque;
 import java.util.List;
 import java.util.NoSuchElementException;
 import java.util.Queue;
@@ -28,7 +28,7 @@
  */
 public abstract class AbstractBreadthFirstIterator<T, S> implements TreeIterator<T> {
 
-    private final Queue<Pair<S, Integer>> queue = new LinkedList<>();
+    private final Queue<Pair<S, Integer>> queue = new ArrayDeque<>(32);
 
     private int currentDepth = -1;
 

patternfx-core/src/main/java/com/techsenger/patternfx/core/AbstractDepthFirstIterator.java

@@ -16,9 +16,10 @@
 
 package com.techsenger.patternfx.core;
 
+import java.util.ArrayDeque;
+import java.util.Deque;
 import java.util.List;
 import java.util.NoSuchElementException;
-import java.util.Stack;
 import javafx.util.Pair;
 
 /**
@@ -27,12 +28,12 @@
  */
 public abstract class AbstractDepthFirstIterator<T, S> implements TreeIterator<T> {
 
-    private final Stack<Pair<S, Integer>> stack = new Stack<>();
+    private final Deque<Pair<S, Integer>> stack = new ArrayDeque<>(32);
 
     private int currentDepth = -1;
 
     protected AbstractDepthFirstIterator(S root) {
-        stack.push(new Pair<>(root, 0));
+        stack.addFirst(new Pair<>(root, 0));
     }
 
     @Override
@@ -45,21 +46,21 @@ public int getDepth() {
 
     @Override
     public boolean hasNext() {
-         return !stack.isEmpty();
+        return !stack.isEmpty();
     }
 
     @Override
     public T next() {
         if (!hasNext()) {
             throw new NoSuchElementException();
         }
-        var pair = stack.pop();
+        var pair = stack.removeFirst();
         S node = pair.getKey();
         this.currentDepth = pair.getValue();
         var children = getChildren(node);
         for (int i = children.size() - 1; i >= 0; i--) {
-            S child =  children.get(i);
-            stack.push(new Pair<>(child, currentDepth + 1));
+            S child = children.get(i);
+            stack.addFirst(new Pair<>(child, currentDepth + 1));
         }
         return map(node);
     }

patternfx-core/src/main/java/com/techsenger/patternfx/core/AbstractDescriptor.java

@@ -16,6 +16,7 @@
 
 package com.techsenger.patternfx.core;
 
+import com.techsenger.annotations.Nullable;
 import java.util.Objects;
 import java.util.UUID;
 import java.util.function.Function;
@@ -50,7 +51,7 @@ public static void setLogPrefixResolver(Function<ReadOnlyDescriptor, String> log
 
     private final ReadOnlyObjectWrapper<ComponentState> state = new ReadOnlyObjectWrapper<>(ComponentState.CREATING);
 
-    private final  ReadOnlyObjectWrapper<ComponentGroup> group = new ReadOnlyObjectWrapper<>();
+    private final ReadOnlyObjectWrapper<ComponentGroup> group = new ReadOnlyObjectWrapper<>();
 
     protected AbstractDescriptor(ComponentName name) {
         this(name, UUID.randomUUID());
@@ -95,19 +96,19 @@ public ComponentState getState() {
     }
 
     @Override
-    public ComponentGroup getGroup() {
+    public @Nullable ComponentGroup getGroup() {
        return group.get();
     }
 
     protected void setState(ComponentState state) {
         this.state.set(state);
     }
 
-    protected void setGroup(ComponentGroup group) {
+    protected void setGroup(@Nullable ComponentGroup group) {
         this.group.set(group);
     }
 
-    protected  ReadOnlyObjectWrapper<ComponentState> getStateWrapper() {
+    protected ReadOnlyObjectWrapper<ComponentState> getStateWrapper() {
         return state;
     }
 

patternfx-core/src/main/java/com/techsenger/patternfx/core/AbstractName.java

@@ -16,15 +16,17 @@
 
 package com.techsenger.patternfx.core;
 
+import com.techsenger.annotations.Nullable;
+
 /**
  *
  * @author Pavel Castornii
  */
 public abstract class AbstractName implements Name {
 
-    private final String text;
+    private final @Nullable String text;
 
-    public AbstractName(String text) {
+    public AbstractName(@Nullable String text) {
         this.text = text;
     }
 
@@ -33,12 +35,13 @@ public AbstractName(String text) {
      *
      * @return the component name text
      */
-    public String getText() {
+    @Override
+    public @Nullable String getText() {
         return text;
     }
 
     @Override
     public String toString() {
-        return this.text;
+        return getClass().getSimpleName() + "[text=" + String.valueOf(text) + "]";
     }
 }

patternfx-core/src/main/java/com/techsenger/patternfx/core/ComponentGroupName.java

@@ -16,6 +16,8 @@
 
 package com.techsenger.patternfx.core;
 
+import java.util.Objects;
+
 /**
  *
  * @author Pavel Castornii
@@ -33,6 +35,6 @@ public ComponentGroupName(String text) {
      */
     @Override
     public String getText() {
-        return super.getText();
+        return Objects.requireNonNull(super.getText());
     }
 }

patternfx-core/src/main/java/com/techsenger/patternfx/core/Name.java

@@ -16,6 +16,8 @@
 
 package com.techsenger.patternfx.core;
 
+import com.techsenger.annotations.Nullable;
+
 /**
  *
  * @author Pavel Castornii
@@ -27,5 +29,5 @@ public interface Name {
      *
      * @return the component name text
      */
-    String getText();
+    @Nullable String getText();
 }

patternfx-core/src/main/java/com/techsenger/patternfx/core/ObservableReadOnlyDescriptor.java

@@ -28,7 +28,6 @@ public interface ObservableReadOnlyDescriptor extends ReadOnlyDescriptor {
     /**
      * Returns the state property of the component.
      *
-     * @return
      */
     ReadOnlyObjectProperty<ComponentState> stateProperty();
 

patternfx-core/src/main/java/com/techsenger/patternfx/core/ReadOnlyDescriptor.java

@@ -16,6 +16,7 @@
 
 package com.techsenger.patternfx.core;
 
+import com.techsenger.annotations.Nullable;
 import java.util.UUID;
 
 /**
@@ -43,8 +44,6 @@ public interface ReadOnlyDescriptor {
 
     /**
      * Returns the first 32 bits of the UUID.
-     *
-     * @return
      */
     String getShortUuid();
 
@@ -68,7 +67,6 @@ public interface ReadOnlyDescriptor {
 
     /**
      * Returns the state of the component.
-     * @return
      */
     ComponentState getState();
 
@@ -77,5 +75,5 @@ public interface ReadOnlyDescriptor {
      *
      * @return the current component group
      */
-    ComponentGroup getGroup();
+    @Nullable ComponentGroup getGroup();
 }

patternfx-core/src/main/java/com/techsenger/patternfx/core/package-info.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2024-2025 Pavel Castornii.
+ *
+ * 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.
+ */
+
+@NullMarked
+package com.techsenger.patternfx.core;
+
+import com.techsenger.annotations.NullMarked;
+