Bring in Lombok.

skeeto · skeeto · commit 60c4d2a5bba9 · 2011-12-09T15:30:17.000-05:00
diff --git a/build.xml b/build.xml
@@ -90,10 +90,18 @@
     <delete file="cache.properties"/>
   </target>
 
-  <target name="javadoc" description="Generate Javadoc HTML.">
+  <target name="javadoc" depends="resolve,compile"
+          description="Generate documentation.">
+    <taskdef classname="lombok.delombok.ant.DelombokTask" name="delombok"
+             classpathref="build.classpath"/>
+    <delombok verbose="true" to="${build.dir}/src" from="${src.dir}">
+      <classpath refid="build.classpath"/>
+    </delombok>
     <javadoc destdir="${dist.dir}/javadoc"
              link="http://download.oracle.com/javase/6/docs/api/"
-             sourcepath="${src.dir}"/>
+             sourcepath="${build.dir}/src">
+      <classpath refid="build.classpath"/>
+    </javadoc>
   </target>
 
   <target name="format" description="Run the indenter on all source files.">
diff --git a/ivy.xml b/ivy.xml
@@ -11,6 +11,8 @@
                 conf="default->default"/>
     <dependency org="junit" name="junit" rev="4.10"
                 conf="test->default"/>
+    <dependency org="org.projectlombok" name="lombok" rev="0.10.4"
+                conf="build->default"/>
     <dependency org="com.puppycrawl.tools" name="checkstyle" rev="5.5"
                 conf="build->default"/>
   </dependencies>
diff --git a/src/sample/java/project/SampleJavaProject.java b/src/sample/java/project/SampleJavaProject.java
@@ -2,31 +2,34 @@
 
 import java.util.Timer;
 import java.util.TimerTask;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+import lombok.Setter;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.GnuParser;
 import org.apache.commons.cli.HelpFormatter;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
 
 /**
- * The main class.
- *
- * This is the main class of the application. It contains the main()
- * method, the first method called.
+ * The main class of the application. It contains the main() method,
+ * the first method called.
  */
+@NoArgsConstructor
+@AllArgsConstructor
 public class SampleJavaProject extends TimerTask {
 
     /** The delay between printed messages. */
     private static final long PRINT_DELAY = 1000L;
 
     /** The name to printed in the output message. */
-    private static String name = "world";
+    @Getter @Setter @NonNull
+    private String name = "world";
 
     /**
-     * The main class.
-     *
      * Print the "Hello, world!" string.
-     *
      * @param args application input arguments
      */
     public static void main(final String[] args) {
@@ -44,37 +47,26 @@ public static void main(final String[] args) {
         }
 
         /* Handle each argument. */
+        SampleJavaProject sjp;
         if (line.hasOption("help")) {
             HelpFormatter formatter = new HelpFormatter();
             formatter.printHelp("SampleJavaProject [options]", options);
             System.exit(0);
         }
         if (line.hasOption("name")) {
-            name = line.getOptionValue("name");
+            sjp = new SampleJavaProject(line.getOptionValue("name"));
+        } else {
+            sjp = new SampleJavaProject();
         }
         if (line.hasOption("loop")) {
-            new Timer().schedule(new SampleJavaProject(), 0L, PRINT_DELAY);
+            new Timer().schedule(sjp, 0L, PRINT_DELAY);
         } else {
-            new SampleJavaProject().run();
+            sjp.run();
         }
     }
 
     @Override
     public final void run() {
         System.out.printf("Hello, %s!\n", name);
     }
-
-    /**
-     * Add two integers together.
-     *
-     * This is a dumb method that is here for the purposed of unit
-     * testing.
-     *
-     * @param  a first number
-     * @param  b second number
-     * @return sum of the numbers
-     */
-    public final int add(final int a, final int b) {
-        return a + b;
-    }
 }
diff --git a/test/sample/java/project/SampleJavaProjectTest.java b/test/sample/java/project/SampleJavaProjectTest.java
@@ -1,13 +1,12 @@
 package sample.java.project;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
 import org.junit.Before;
 import org.junit.Test;
 
 /**
- * A sample JUnit test.
- *
- * This test exists as a placeholder for the test unit framework.
+ * Sample JUnit tests.
  */
 public class SampleJavaProjectTest {
 
@@ -25,12 +24,19 @@ public final void setUp() {
     }
 
     /**
-     * Tests the add() method in the main class.
+     * Tests the generated setter and getter methods.
      */
     @Test
-    public final void testAdd() {
-        assertEquals(sjp.add(3, 4), 7);
-        assertEquals(sjp.add(5, -5), 0);
-        assertEquals(sjp.add(-3, 4), 1);
+    public final void testGetSet() {
+        sjp.setName("foo");
+        assertEquals("foo", sjp.getName());
+    }
+
+    /**
+     * Tests that the null check in the setter.
+     */
+    @Test(expected=NullPointerException.class)
+    public final void nullTest() {
+        sjp.setName(null);
     }
 }
