add descriptive null handling

Oblarg · Jun 3, 2019 · b5f313b · b5f313b
1 parent b8d6357
commit b5f313b
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 0 deletions.
diff --git a/lib/src/main/java/io/github/oblarg/oblog/NTContainer.java b/lib/src/main/java/io/github/oblarg/oblog/NTContainer.java
@@ -4,6 +4,8 @@
 import edu.wpi.first.wpilibj.Sendable;
 import edu.wpi.first.wpilibj.shuffleboard.LayoutType;
 
+import static io.github.oblarg.oblog.Util.nullCheck;
+
 class NTContainer implements ShuffleboardContainerWrapper {
 
   NetworkTable table;
@@ -19,11 +21,13 @@ public ShuffleboardLayoutWrapper getLayout(String title, LayoutType type) {
 
   @Override
   public SimpleWidgetWrapper add(String title, Object defaultValue) {
+    nullCheck(defaultValue, title, table.getPath());
     return new NTSimpleWidget(table.getEntry(title), defaultValue);
   }
 
   @Override
   public ComplexWidgetWrapper add(String title, Sendable defaultValue) {
+    nullCheck(defaultValue, title, table.getPath());
     return new NTComplexWidget(table, title, defaultValue);
   }
 }
diff --git a/lib/src/main/java/io/github/oblarg/oblog/NTLayout.java b/lib/src/main/java/io/github/oblarg/oblog/NTLayout.java
@@ -6,6 +6,8 @@
 
 import java.util.Map;
 
+import static io.github.oblarg.oblog.Util.nullCheck;
+
 class NTLayout implements ShuffleboardLayoutWrapper {
 
   private NetworkTable table;
@@ -26,11 +28,13 @@ public ShuffleboardLayoutWrapper getLayout(String title, LayoutType type) {
 
   @Override
   public SimpleWidgetWrapper add(String title, Object defaultValue) {
+    nullCheck(defaultValue, title, table.getPath());
     return new NTSimpleWidget(table.getEntry(title), defaultValue);
   }
 
   @Override
   public ComplexWidgetWrapper add(String title, Sendable defaultValue) {
+    nullCheck(defaultValue, title, table.getPath());
     return new NTComplexWidget(table, title, defaultValue);
   }
 

diff --git a/lib/src/main/java/io/github/oblarg/oblog/Util.java b/lib/src/main/java/io/github/oblarg/oblog/Util.java
@@ -0,0 +1,10 @@
+package io.github.oblarg.oblog;
+
+import static java.util.Objects.requireNonNull;
+
+public class Util {
+  public static void nullCheck(Object obj, String title, String containerName) {
+    requireNonNull(obj, "Error!  Attempted to log null value with widget title " + title + " in container "
+        + containerName);
+  }
+}
diff --git a/lib/src/main/java/io/github/oblarg/oblog/WrappedShuffleboardContainer.java b/lib/src/main/java/io/github/oblarg/oblog/WrappedShuffleboardContainer.java
@@ -4,6 +4,8 @@
 import edu.wpi.first.wpilibj.shuffleboard.LayoutType;
 import edu.wpi.first.wpilibj.shuffleboard.ShuffleboardContainer;
 
+import static io.github.oblarg.oblog.Util.nullCheck;
+
 class WrappedShuffleboardContainer implements ShuffleboardContainerWrapper {
 
   private ShuffleboardContainer container;
@@ -19,11 +21,13 @@ public ShuffleboardLayoutWrapper getLayout(String title, LayoutType type) {
 
   @Override
   public SimpleWidgetWrapper add(String title, Object defaultValue) {
+    nullCheck(defaultValue, title, container.getTitle());
     return new WrappedSimpleWidget(container.add(title, defaultValue));
   }
 
   @Override
   public ComplexWidgetWrapper add(String title, Sendable defaultValue) {
+    nullCheck(defaultValue, title, container.getTitle());
     return new WrappedComplexWidget(container.add(title, defaultValue));
   }
 }
diff --git a/lib/src/main/java/io/github/oblarg/oblog/WrappedShuffleboardLayout.java b/lib/src/main/java/io/github/oblarg/oblog/WrappedShuffleboardLayout.java
@@ -6,6 +6,8 @@
 
 import java.util.Map;
 
+import static io.github.oblarg.oblog.Util.nullCheck;
+
 class WrappedShuffleboardLayout implements ShuffleboardLayoutWrapper {
 
   private ShuffleboardLayout layout;
@@ -21,11 +23,13 @@ public ShuffleboardLayoutWrapper getLayout(String title, LayoutType type) {
 
   @Override
   public SimpleWidgetWrapper add(String title, Object defaultValue) {
+    nullCheck(defaultValue, title, layout.getTitle());
     return new WrappedSimpleWidget(layout.add(title, defaultValue));
   }
 
   @Override
   public ComplexWidgetWrapper add(String title, Sendable defaultValue) {
+    nullCheck(defaultValue, title, layout.getTitle());
     return new WrappedComplexWidget(layout.add(title, defaultValue));
   }