From 6b4656afff5a6677bd609f120114ad85dd0d31d0 Mon Sep 17 00:00:00 2001
From: oblonski <4sschroeder@gmail.com>
Date: Thu, 16 Jan 2014 17:07:38 -0500
Subject: [PATCH] add javadocs and tests

---
 .../jsprit/core/problem/job/Delivery.java     | 32 +++++++++++++++--
 .../java/jsprit/core/problem/job/Pickup.java  | 34 ++++++++++++++++++-
 .../jsprit/core/problem/job/DeliveryTest.java | 12 +++++++
 .../jsprit/core/problem/job/PickupTest.java   | 12 +++++++
 4 files changed, 87 insertions(+), 3 deletions(-)
 create mode 100644 jsprit-core/src/test/java/jsprit/core/problem/job/DeliveryTest.java
 create mode 100644 jsprit-core/src/test/java/jsprit/core/problem/job/PickupTest.java

diff --git a/jsprit-core/src/main/java/jsprit/core/problem/job/Delivery.java b/jsprit-core/src/main/java/jsprit/core/problem/job/Delivery.java
index 79532708..f3c29a2a 100644
--- a/jsprit-core/src/main/java/jsprit/core/problem/job/Delivery.java
+++ b/jsprit-core/src/main/java/jsprit/core/problem/job/Delivery.java
@@ -16,19 +16,42 @@
  ******************************************************************************/
 package jsprit.core.problem.job;
 
-
+/**
+ * Delivery extends Service and is intended to model a Service where smth is UNLOADED (i.e. delivered) from a transport unit.
+ * 
+ * @author schroeder
+ *
+ */
 public class Delivery extends Service{
 	
 	public static class Builder extends Service.Builder {
 
+		/**
+		 * Returns a new instance of Delivery.Builder
+		 * 
+		 * @param id
+		 * @param size
+		 * @return builder
+		 */
 		public static Builder newInstance(String id, int size){
 			return new Builder(id,size);
 		}
 		
+		/**
+		 * Constructs the builder
+		 * 
+		 * @param id
+		 * @param size
+		 */
 		Builder(String id, int size) {
 			super(id, size);
 		}
-		
+		/**
+		 * Builds Delivery.
+		 * 
+		 * @return delivery
+		 * @throw {@link IllegalStateException} if neither locationId nor coord is set
+		 */
 		public Delivery build(){
 			if(locationId == null) { 
 				if(coord == null) throw new IllegalStateException("either locationId or a coordinate must be given. But is not.");
@@ -40,6 +63,11 @@ public class Delivery extends Service{
 		
 	}
 	
+	/**
+	 * Constructs Delivery.
+	 * 
+	 * @param builder
+	 */
 	Delivery(Builder builder) {
 		super(builder);
 		
diff --git a/jsprit-core/src/main/java/jsprit/core/problem/job/Pickup.java b/jsprit-core/src/main/java/jsprit/core/problem/job/Pickup.java
index e706d27f..f14ec34d 100644
--- a/jsprit-core/src/main/java/jsprit/core/problem/job/Pickup.java
+++ b/jsprit-core/src/main/java/jsprit/core/problem/job/Pickup.java
@@ -16,18 +16,45 @@
  ******************************************************************************/
 package jsprit.core.problem.job;
 
+/**
+ * Pickup extends Service and is intended to model a Service where smth is LOADED (i.e. picked up) to a transport unit.
+ * 
+ * @author schroeder
+ *
+ */
 public class Pickup extends Service {
 
 	public static class Builder extends Service.Builder {
-
+		
+		/**
+		 * Returns a new instance of Pickup.Builder
+		 * 
+		 * @param id
+		 * @param size
+		 * @return builder
+		 */
 		public static Builder newInstance(String id, int size){
 			return new Builder(id,size);
 		}
 		
+		/**
+		 * Constructs the builder.
+		 * 
+		 * @param id
+		 * @param size
+		 */
 		Builder(String id, int size) {
 			super(id, size);
 		}
 		
+		/**
+		 * Builds Pickup.
+		 * 
+		 *<p>Pickup type is "pickup"
+		 *
+		 * @return pickup
+		 * @throw {@link IllegalStateException} if neither locationId nor coordinate has been set
+		 */
 		public Pickup build(){
 			if(locationId == null) { 
 				if(coord == null) throw new IllegalStateException("either locationId or a coordinate must be given. But is not.");
@@ -39,6 +66,11 @@ public class Pickup extends Service {
 		
 	}
 	
+	/**
+	 * Constructs the Pickup
+	 * 
+	 * @param builder
+	 */
 	Pickup(Builder builder) {
 		super(builder);
 	}
diff --git a/jsprit-core/src/test/java/jsprit/core/problem/job/DeliveryTest.java b/jsprit-core/src/test/java/jsprit/core/problem/job/DeliveryTest.java
new file mode 100644
index 00000000..1ca82c45
--- /dev/null
+++ b/jsprit-core/src/test/java/jsprit/core/problem/job/DeliveryTest.java
@@ -0,0 +1,12 @@
+package jsprit.core.problem.job;
+
+import org.junit.Test;
+
+public class DeliveryTest {
+	
+	@Test(expected=IllegalStateException.class)
+	public void whenNeitherLocationIdNorCoordIsSet_itThrowsException(){
+		Delivery.Builder.newInstance("p", 0).build();
+	}
+
+}
diff --git a/jsprit-core/src/test/java/jsprit/core/problem/job/PickupTest.java b/jsprit-core/src/test/java/jsprit/core/problem/job/PickupTest.java
new file mode 100644
index 00000000..73b60ed5
--- /dev/null
+++ b/jsprit-core/src/test/java/jsprit/core/problem/job/PickupTest.java
@@ -0,0 +1,12 @@
+package jsprit.core.problem.job;
+
+import org.junit.Test;
+
+public class PickupTest {
+	
+	@Test(expected=IllegalStateException.class)
+	public void whenNeitherLocationIdNorCoordIsSet_itThrowsException(){
+		Pickup.Builder.newInstance("p", 0).build();
+	}
+
+}