Add JSpecify to spring-shell-table

Signed-off-by: Piotr Olaszewski <[email protected]>

Author: piotrooo

spring-shell-table/src/main/java/org/springframework/shell/package-info.java

@@ -0,0 +1,4 @@
+@NullMarked
+package org.springframework.shell;
+
+import org.jspecify.annotations.NullMarked;

spring-shell-table/src/main/java/org/springframework/shell/table/ArrayTableModel.java

@@ -16,12 +16,14 @@
 
 package org.springframework.shell.table;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.util.Assert;
 
 /**
  * A TableModel backed by a row-first array.
  *
  * @author Eric Bottard
+ * @author Piotr Olaszewski
  */
 public class ArrayTableModel extends TableModel {
 
@@ -43,7 +45,7 @@ public int getColumnCount() {
 		return data.length > 0 ? data[0].length : 0;
 	}
 
-	public Object getValue(int row, int column) {
+	public @Nullable Object getValue(int row, int column) {
 		return data[row][column];
 	}
 }

spring-shell-table/src/main/java/org/springframework/shell/table/BeanListTableModel.java

@@ -22,9 +22,11 @@
 import java.util.LinkedHashMap;
 import java.util.List;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.beans.BeanUtils;
 import org.springframework.beans.BeanWrapper;
 import org.springframework.beans.BeanWrapperImpl;
+import org.springframework.util.Assert;
 
 /**
  * A table model that is backed by a list of beans.
@@ -33,14 +35,15 @@
  * a convenience constructor for adding a special header row.</p>
  *
  * @author Eric Bottard
+ * @author Piotr Olaszewski
  */
 public class BeanListTableModel<T> extends TableModel {
 
 	private final List<BeanWrapper> data;
 
 	private final List<String> propertyNames;
 
-	private final List<Object> headerRow;
+	private final @Nullable List<Object> headerRow;
 
 	public BeanListTableModel(Class<T> clazz, Iterable<T> list) {
 		this.data = new ArrayList<BeanWrapper>();
@@ -86,14 +89,16 @@ public int getColumnCount() {
 	}
 
 	@Override
-	public Object getValue(int row, int column) {
+	public @Nullable Object getValue(int row, int column) {
 		if (headerRow != null && row == 0) {
 			return headerRow.get(column);
 		}
 		else {
 			int rowToUse = headerRow == null ? row : row - 1;
 			String propertyName = propertyNames.get(column);
-			return data.get(rowToUse).getPropertyValue(propertyName);
+			BeanWrapper beanWrapper = data.get(rowToUse);
+			Assert.notNull(beanWrapper, "'beanWrapper' must not be null");
+			return beanWrapper.getPropertyValue(propertyName);
 		}
 	}
 }

spring-shell-table/src/main/java/org/springframework/shell/table/BorderSpecification.java

@@ -16,6 +16,7 @@
 
 package org.springframework.shell.table;
 
+import java.lang.reflect.Field;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -27,6 +28,7 @@
  * Multiple specifications can be combined on a single table.
  *
  * @author Eric Bottard
+ * @author Piotr Olaszewski
  */
 public class BorderSpecification {
 
@@ -102,14 +104,22 @@ public String toString() {
 	private String matchConstants() {
 		try {
 			for (String field : new String[] {"NONE", "INNER", "FULL", "OUTLINE"}) {
-				int value = ReflectionUtils.findField(getClass(), field).getInt(null);
+				Field reflectedField = ReflectionUtils.findField(getClass(), field);
+				if (reflectedField == null) {
+					continue;
+				}
+				int value = reflectedField.getInt(null);
 				if (match  == value) {
 					return field;
 				}
 			}
 			List<String> constants = new ArrayList<String>();
 			for (String field : new String[] {"TOP", "BOTTOM", "LEFT", "RIGHT", "INNER_HORIZONTAL", "INNER_VERTICAL"}) {
-				int value = ReflectionUtils.findField(getClass(), field).getInt(null);
+				Field reflectedField = ReflectionUtils.findField(getClass(), field);
+				if (reflectedField == null) {
+					continue;
+				}
+				int value = reflectedField.getInt(null);
 				if ((match & value) == value) {
 					constants.add(field);
 				}

spring-shell-table/src/main/java/org/springframework/shell/table/DefaultFormatter.java

@@ -16,14 +16,17 @@
 
 package org.springframework.shell.table;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * A very simple formatter that uses {@link Object#toString()} and splits on newlines.
  *
  * @author Eric Bottard
+ * @author Piotr Olaszewski
  */
 public class DefaultFormatter implements Formatter {
 
-	public String[] format(Object value) {
+	public String[] format(@Nullable Object value) {
 		return value == null ? new String[] {""} : value.toString().split("\n");
 	}
 

spring-shell-table/src/main/java/org/springframework/shell/table/Formatter.java

@@ -16,6 +16,8 @@
 
 package org.springframework.shell.table;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * A Formatter is responsible for the initial rendering of a value to lines of text.
  *
@@ -24,8 +26,9 @@
  * raw text representation (<i>e.g.</i> format numbers).</p>
  *
  * @author Eric Bottard
+ * @author Piotr Olaszewski
  */
 public interface Formatter {
 
-	public String[] format(Object value);
+	public String[] format(@Nullable Object value);
 }

spring-shell-table/src/main/java/org/springframework/shell/table/MapFormatter.java

@@ -16,12 +16,15 @@
 
 package org.springframework.shell.table;
 
+import org.jspecify.annotations.Nullable;
+
 import java.util.Map;
 
 /**
  * A formatter suited for key-value pairs, that renders each mapping on a new line.
  *
  * @author Eric Bottard
+ * @author Piotr Olaszewski
  */
 public class MapFormatter implements Formatter {
 
@@ -32,7 +35,10 @@ public MapFormatter(String separator) {
 	}
 
 	@Override
-	public String[] format(Object value) {
+	public String[] format(@Nullable Object value) {
+		if (value == null) {
+			return new String[]{""};
+		}
 		Map<?, ?> map = (Map<?, ?>) value;
 		String[] result = new String[map.size()];
 		int i = 0;

spring-shell-table/src/main/java/org/springframework/shell/table/TableModel.java

@@ -16,10 +16,13 @@
 
 package org.springframework.shell.table;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Abstracts away the contract a {@link Table} will use to retrieve tabular data.
  *
  * @author Eric Bottard
+ * @author Piotr Olaszewski
  */
 public abstract class TableModel {
 
@@ -40,7 +43,7 @@ public abstract class TableModel {
 	 * @param row the row that is being queried
 	 * @param column the column that is being queried
 	 */
-	public abstract Object getValue(int row, int column);
+	public abstract @Nullable Object getValue(int row, int column);
 
 	/**
 	 * @return a transposed view of this model, where rows become columns and vice-versa.
@@ -58,7 +61,7 @@ public int getColumnCount() {
 			}
 
 			@Override
-			public Object getValue(int row, int column) {
+			public @Nullable Object getValue(int row, int column) {
 				return TableModel.this.getValue(column, row);
 			}
 		};

spring-shell-table/src/main/java/org/springframework/shell/table/TableModelBuilder.java

@@ -19,12 +19,14 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.util.Assert;
 
 /**
  * Helper class to build a TableModel incrementally.
  *
  * @author Eric Bottard
+ * @author Piotr Olaszewski
  */
 public class TableModelBuilder<T> {
 
@@ -74,7 +76,7 @@ public int getColumnCount() {
 			}
 
 			@Override
-			public Object getValue(int row, int column) {
+			public @Nullable Object getValue(int row, int column) {
 				return rows.get(row).get(column);
 			}
 		};

spring-shell-table/src/main/java/org/springframework/shell/table/package-info.java

@@ -19,4 +19,7 @@
  *
  * @author Eric Bottard
  */
-package org.springframework.shell.table;
+@NullMarked
+package org.springframework.shell.table;
+
+import org.jspecify.annotations.NullMarked;