From 3c086280546719f539a9dcfff042c6d4432a0b77 Mon Sep 17 00:00:00 2001
From: Philip Durbin <philipdurbin@gmail.com>
Date: Fri, 21 Aug 2015 17:47:43 -0400
Subject: [PATCH] enable checker framework. thanks @renatoathaydes !

Inspired by https://github.com/renatoathaydes/checker-maven-demo which I
found at https://github.com/typetools/checker-framework/issues/445
---
 my-app/pom.xml                                | 50 +++++++++++++++++++
 .../src/main/java/com/mycompany/app/App.java  | 16 ++++++
 2 files changed, 66 insertions(+)

diff --git a/my-app/pom.xml b/my-app/pom.xml
index d4dcaa7d4..d9982043e 100644
--- a/my-app/pom.xml
+++ b/my-app/pom.xml
@@ -7,6 +7,12 @@
   <version>1.0-SNAPSHOT</version>
   <name>my-app</name>
   <url>http://maven.apache.org</url>
+
+  <properties>
+      <!-- This property will be set by the Maven Dependency plugin -->
+      <annotatedJdk>${org.checkerframework:jdk8:jar}</annotatedJdk>
+  </properties>
+
   <dependencies>
     <dependency>
       <groupId>junit</groupId>
@@ -14,6 +20,21 @@
       <version>3.8.1</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+        <groupId>org.checkerframework</groupId>
+        <artifactId>checker</artifactId>
+        <version>1.9.4</version>
+    </dependency>
+    <dependency>
+        <groupId>org.checkerframework</groupId>
+        <artifactId>checker-qual</artifactId>
+        <version>1.9.4</version>
+    </dependency>
+    <dependency>
+        <groupId>org.checkerframework</groupId>
+        <artifactId>jdk8</artifactId>
+        <version>1.9.4</version>
+    </dependency>
   </dependencies>
   <build>
     <plugins>
@@ -55,6 +76,35 @@
 	  </execution>
 	</executions>
       </plugin>
+      <plugin>
+          <!-- This plugin will set the properties values using dependency information -->
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-dependency-plugin</artifactId>
+          <version>2.3</version>
+          <executions>
+              <execution>
+                  <goals>
+                      <goal>properties</goal>
+                  </goals>
+              </execution>
+          </executions>
+      </plugin>
+      <plugin>
+          <artifactId>maven-compiler-plugin</artifactId>
+          <configuration>
+              <source>1.8</source>
+              <target>1.8</target>
+              <fork>true</fork>
+              <!-- Add all the checkers you want to enable here -->
+              <annotationProcessors>
+                  <annotationProcessor>org.checkerframework.checker.nullness.NullnessChecker</annotationProcessor>
+              </annotationProcessors>
+              <compilerArgs>
+                  <!-- location of the annotated JDK, which comes from a Maven dependency -->
+                  <arg>-Xbootclasspath/p:${annotatedJdk}</arg>
+              </compilerArgs>
+          </configuration>
+      </plugin>
     </plugins>
   </build>
 </project>
diff --git a/my-app/src/main/java/com/mycompany/app/App.java b/my-app/src/main/java/com/mycompany/app/App.java
index 77cf3e055..826f7770e 100644
--- a/my-app/src/main/java/com/mycompany/app/App.java
+++ b/my-app/src/main/java/com/mycompany/app/App.java
@@ -9,5 +9,21 @@ public class App
     public static void main( String[] args )
     {
         System.out.println( "Hello World!" );
+
+        System.out.println("A NullPointerException is a drag...");
+        Object myObject = null;
+        /**
+         * Checker prevents this from compiling...
+         */
+//        System.out.println("myObject: " + myObject.toString());
+        /**
+         * ... which is simply fantastic. It shows:
+         *
+         * error: [dereference.of.nullable] dereference of possibly-null
+         * reference myObject
+         *
+         * http://checkerframework.org
+         */
+        System.out.println("... but thankfully, Checker has our back: http://checkerframework.org");
     }
 }