Improved ctor of CarrierMovement by better assertions and j.u.Date defensive copying. Updated tests.

dddsample/tracking/core/src/main/java/se/citerus/dddsample/tracking/core/domain/model/voyage/CarrierMovement.java

@@ -10,19 +10,13 @@ import java.util.Date;
 /**
  * A carrier movement is a vessel voyage from one location to another.
  */
-public final class CarrierMovement extends ValueObjectSupport<CarrierMovement> {
+public class CarrierMovement extends ValueObjectSupport<CarrierMovement> {
 
   private final Location departureLocation;
   private final Location arrivalLocation;
   private final Date departureTime;
   private final Date arrivalTime;
 
-  // Null object pattern 
-  public static final CarrierMovement NONE = new CarrierMovement(
-    Location.UNKNOWN, Location.UNKNOWN,
-    new Date(0), new Date(0)
-  );
-
   /**
    * Constructor.
    *
@@ -31,14 +25,19 @@ public final class CarrierMovement extends ValueObjectSupport<CarrierMovement> {
    * @param departureTime     time of departure
    * @param arrivalTime       time of arrival
    */
-  // TODO make package local
-  public CarrierMovement(Location departureLocation,
-                         Location arrivalLocation,
-                         Date departureTime,
-                         Date arrivalTime) {
-    Validate.noNullElements(new Object[]{departureLocation, arrivalLocation, departureTime, arrivalTime});
-    this.departureTime = departureTime;
-    this.arrivalTime = arrivalTime;
+  CarrierMovement(final Location departureLocation,
+                  final Location arrivalLocation,
+                  final Date departureTime,
+                  final Date arrivalTime) {
+    Validate.notNull(departureLocation, "Departure location is required");
+    Validate.notNull(arrivalLocation, "Arrival location is required");
+    Validate.notNull(departureTime, "Departure time is required");
+    Validate.notNull(arrivalTime, "Arrival time is required");
+    Validate.isTrue(arrivalTime.after(departureTime), "Arrival time must be after departure time");
+    Validate.isTrue(!departureLocation.sameAs(arrivalLocation), "Departure location can't be the same as the arrival location");
+    
+    this.departureTime = new Date(departureTime.getTime());
+    this.arrivalTime = new Date(arrivalTime.getTime());
     this.departureLocation = departureLocation;
     this.arrivalLocation = arrivalLocation;
   }

dddsample/tracking/core/src/main/java/se/citerus/dddsample/tracking/core/domain/model/voyage/SampleVoyages.java

@@ -21,7 +21,7 @@ public class SampleVoyages {
 
   private static Voyage createVoyage(String id, Location from, Location to) {
     return new Voyage(new VoyageNumber(id), new Schedule(Arrays.asList(
-      new CarrierMovement(from, to, new Date(), new Date())
+      new CarrierMovement(from, to, new Date(1), new Date(2))
     )));
   }
 
@@ -111,7 +111,7 @@ public class SampleVoyages {
       addMovement(HONGKONG, toDate("2008-11-24", "07:00"), toDate("2008-11-28", "13:37")).
       build();
 
-  public static final Map<VoyageNumber, Voyage> ALL = new HashMap();
+  public static final Map<VoyageNumber, Voyage> ALL = new HashMap<VoyageNumber, Voyage>();
 
   static {
     for (Field field : SampleVoyages.class.getDeclaredFields()) {

dddsample/tracking/core/src/main/java/se/citerus/dddsample/tracking/core/domain/model/voyage/Schedule.java

@@ -18,9 +18,9 @@ public class Schedule extends ValueObjectSupport<Schedule> {
   public static final Schedule EMPTY = new Schedule();
 
   Schedule(final List<CarrierMovement> carrierMovements) {
-    Validate.notNull(carrierMovements);
-    Validate.noNullElements(carrierMovements);
-    Validate.notEmpty(carrierMovements);
+    Validate.notNull(carrierMovements, "Carrier movements are required");
+    Validate.noNullElements(carrierMovements, "There are null elements in the list of carrier movments");
+    Validate.notEmpty(carrierMovements, "There must be at least one carrier movement in a schedule");
 
     this.carrierMovements = carrierMovements;
   }
@@ -60,6 +60,6 @@ public class Schedule extends ValueObjectSupport<Schedule> {
 
   Schedule() {
     // Needed by Hibernate
-    carrierMovements = null;
+    carrierMovements = Collections.emptyList();
   }
 }

dddsample/tracking/core/src/main/java/se/citerus/dddsample/tracking/core/domain/model/voyage/Voyage.java

@@ -85,20 +85,20 @@ public class Voyage extends EntitySupport<Voyage,VoyageNumber> {
 
     private final List<CarrierMovement> carrierMovements = new ArrayList<CarrierMovement>();
     private final VoyageNumber voyageNumber;
-    private Location departureLocation;
+    private Location currentDepartureLocation;
 
-    public Builder(final VoyageNumber voyageNumber, final Location departureLocation) {
+    public Builder(final VoyageNumber voyageNumber, final Location initialDepartureLocation) {
       Validate.notNull(voyageNumber, "Voyage number is required");
-      Validate.notNull(departureLocation, "Departure location is required");
+      Validate.notNull(initialDepartureLocation, "Departure location is required");
 
       this.voyageNumber = voyageNumber;
-      this.departureLocation = departureLocation;
+      this.currentDepartureLocation = initialDepartureLocation;
     }
 
-    public Builder addMovement(Location arrivalLocation, Date departureTime, Date arrivalTime) {
-      carrierMovements.add(new CarrierMovement(departureLocation, arrivalLocation, departureTime, arrivalTime));
+    public Builder addMovement(final Location arrivalLocation, final Date departureTime, final Date arrivalTime) {
+      carrierMovements.add(new CarrierMovement(currentDepartureLocation, arrivalLocation, departureTime, arrivalTime));
       // Next departure location is the same as this arrival location
-      this.departureLocation = arrivalLocation;
+      this.currentDepartureLocation = arrivalLocation;
       return this;
     }
 

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/domain/model/cargo/CargoTest.java

@@ -19,27 +19,27 @@ public class CargoTest extends TestCase {
 
   private Voyage crazyVoyage = new Voyage.Builder(new VoyageNumber("0123"),
     STOCKHOLM).
-    addMovement(HAMBURG, new Date(), new Date()).
-    addMovement(HONGKONG, new Date(), new Date()).
-    addMovement(MELBOURNE, new Date(), new Date()).
+    addMovement(HAMBURG, new Date(1), new Date(2)).
+    addMovement(HONGKONG, new Date(3), new Date(4)).
+    addMovement(MELBOURNE, new Date(5), new Date(6)).
     build();
 
   private Voyage pacific = new Voyage.Builder(new VoyageNumber("4567"),
     SHANGHAI).
-    addMovement(LONGBEACH, new Date(), new Date()).
-    addMovement(SEATTLE, new Date(), new Date()).
+    addMovement(LONGBEACH, new Date(1), new Date(2)).
+    addMovement(SEATTLE, new Date(3), new Date(4)).
     build();
 
   private Voyage transcontinental = new Voyage.Builder(new VoyageNumber("4567"),
     LONGBEACH).
-    addMovement(CHICAGO, new Date(), new Date()).
-    addMovement(NEWYORK, new Date(), new Date()).
+    addMovement(CHICAGO, new Date(1), new Date(2)).
+    addMovement(NEWYORK, new Date(3), new Date(4)).
     build();
 
   private Voyage northernRail = new Voyage.Builder(new VoyageNumber("8901"),
     SEATTLE).
-    addMovement(CHICAGO, new Date(), new Date()).
-    addMovement(NEWYORK, new Date(), new Date()).
+    addMovement(CHICAGO, new Date(1), new Date(2)).
+    addMovement(NEWYORK, new Date(3), new Date(4)).
     build();
 
   public void testConstruction() {
@@ -148,7 +148,7 @@ public class CargoTest extends TestCase {
     assertFalse(cargo.isReadyToClaim());
 
     Voyage voyage = new Voyage.Builder(new VoyageNumber("0123"), HANGZOU).
-      addMovement(NEWYORK, new Date(), new Date()).
+      addMovement(NEWYORK, new Date(1), new Date(2)).
       build();
 
     // Adding an unload event, but not at the final destination

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/domain/model/cargo/ItineraryTest.java

@@ -19,22 +19,22 @@ public class ItineraryTest extends TestCase {
   protected void setUp() throws Exception {
 
     pacific = new Voyage.Builder(new VoyageNumber("4567"), SHANGHAI).
-      addMovement(LONGBEACH, new Date(), new Date()).
+      addMovement(LONGBEACH, new Date(1), new Date(2)).
       build();
 
     transcontinental = new Voyage.Builder(new VoyageNumber("4567"), LONGBEACH).
-      addMovement(CHICAGO, new Date(), new Date()).
-      addMovement(NEWYORK, new Date(), new Date()).
+      addMovement(CHICAGO, new Date(1), new Date(2)).
+      addMovement(NEWYORK, new Date(3), new Date(4)).
       build();
 
     voyage = new Voyage.Builder(new VoyageNumber("0123"), SHANGHAI).
-      addMovement(ROTTERDAM, new Date(), new Date()).
-      addMovement(GOTHENBURG, new Date(), new Date()).
+      addMovement(ROTTERDAM, new Date(1), new Date(2)).
+      addMovement(GOTHENBURG, new Date(3), new Date(4)).
       build();
 
     wrongVoyage = new Voyage.Builder(new VoyageNumber("666"), NEWYORK).
-      addMovement(STOCKHOLM, new Date(), new Date()).
-      addMovement(HELSINKI, new Date(), new Date()).
+      addMovement(STOCKHOLM, new Date(1), new Date(2)).
+      addMovement(HELSINKI, new Date(3), new Date(4)).
       build();
   }
 
@@ -42,8 +42,8 @@ public class ItineraryTest extends TestCase {
 
     Itinerary itinerary = new Itinerary(
       Arrays.asList(
-        new Leg(voyage, SHANGHAI, ROTTERDAM, new Date(), new Date()),
-        new Leg(voyage, ROTTERDAM, GOTHENBURG, new Date(), new Date())
+        new Leg(voyage, SHANGHAI, ROTTERDAM, new Date(1), new Date(2)),
+        new Leg(voyage, ROTTERDAM, GOTHENBURG, new Date(3), new Date(4))
       )
     );
 

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/domain/model/handling/HandlingHistoryTest.java

@@ -28,8 +28,8 @@ public class HandlingHistoryTest extends TestCase {
     cargo2 = new Cargo(new TrackingId("DEF"), new RouteSpecification(SHANGHAI, NEWYORK, toDate("2009-04-15")));
 
     voyage = new Voyage.Builder(new VoyageNumber("X25"), HONGKONG).
-      addMovement(SHANGHAI, new Date(), new Date()).
-      addMovement(DALLAS, new Date(), new Date()).
+      addMovement(SHANGHAI, new Date(1), new Date(2)).
+      addMovement(DALLAS, new Date(3), new Date(4)).
       build();
     event1 = new HandlingEvent(cargo, toDate("2009-03-05"), toDate("2009-03-05"), HandlingEvent.Type.LOAD, SHANGHAI, voyage);
     event1duplicate = new HandlingEvent(cargo, toDate("2009-03-05"), toDate("2009-03-07"), HandlingEvent.Type.LOAD, SHANGHAI, voyage);

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/domain/model/voyage/CarrierMovementTest.java

@@ -27,15 +27,33 @@ public class CarrierMovementTest extends TestCase {
     } catch (IllegalArgumentException expected) {
     }
 
-    // Legal
-    new CarrierMovement(STOCKHOLM, HAMBURG, new Date(), new Date());
+    try {
+      new CarrierMovement(STOCKHOLM, HAMBURG, new Date(200), new Date(100));
+      fail("Should not accept departure time after arrival time");
+    } catch (IllegalArgumentException expected) {
+    }
+
+    try {
+      new CarrierMovement(STOCKHOLM, HAMBURG, new Date(100), new Date(100));
+      fail("Should not accept arrival time equal to departure time");
+    } catch (IllegalArgumentException expected) {
+    }
+
+    try {
+      new CarrierMovement(STOCKHOLM, STOCKHOLM, new Date(100), new Date(200));
+      fail("Should not accept identical departure and arrival locations");
+    } catch (IllegalArgumentException expected) {
+    }
+
+    // Ok
+    new CarrierMovement(STOCKHOLM, HAMBURG, new Date(100), new Date(200));
   }
 
   public void testSameValueAsEqualsHashCode() throws Exception {
-    CarrierMovement cm1 = new CarrierMovement(STOCKHOLM, HAMBURG, new Date(), new Date());
-    CarrierMovement cm2 = new CarrierMovement(STOCKHOLM, HAMBURG, new Date(), new Date());
-    CarrierMovement cm3 = new CarrierMovement(HAMBURG, STOCKHOLM, new Date(), new Date());
-    CarrierMovement cm4 = new CarrierMovement(HAMBURG, STOCKHOLM, new Date(), new Date());
+    CarrierMovement cm1 = new CarrierMovement(STOCKHOLM, HAMBURG, new Date(1), new Date(2));
+    CarrierMovement cm2 = new CarrierMovement(STOCKHOLM, HAMBURG, new Date(1), new Date(2));
+    CarrierMovement cm3 = new CarrierMovement(HAMBURG, STOCKHOLM, new Date(1), new Date(2));
+    CarrierMovement cm4 = new CarrierMovement(HAMBURG, STOCKHOLM, new Date(1), new Date(2));
 
     assertTrue(cm1.sameValueAs(cm2));
     assertFalse(cm2.sameValueAs(cm3));

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/domain/model/voyage/ScheduleTest.java

@@ -4,8 +4,8 @@ import junit.framework.TestCase;
 
 public class ScheduleTest extends TestCase {
 
-  public void testCarrierMovements() throws Exception {
-    //TODO: Test goes here...
+  public void testEmpty() throws Exception {
+    assertTrue(Schedule.EMPTY.carrierMovements().isEmpty());
   }
 
   public void testSameValueAs() throws Exception {

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/domain/model/voyage/VoyageTest.java

@@ -1,19 +1,16 @@
 package se.citerus.dddsample.tracking.core.domain.model.voyage;
 
 import junit.framework.TestCase;
-import static se.citerus.dddsample.tracking.core.domain.model.location.SampleLocations.*;
-
-import java.util.Date;
 
 public class VoyageTest extends TestCase {
 
 
   public void testSchedule() {
-    Voyage transcontinental = new Voyage.Builder(new VoyageNumber("4567"),
+    /*Voyage transcontinental = new Voyage.Builder(new VoyageNumber("4567"),
       LONGBEACH).
-      addMovement(CHICAGO, new Date(), new Date()).
-      addMovement(NEWYORK, new Date(), new Date()).
-      build();
+      addMovement(CHICAGO, new Date(1), new Date(2)).
+      addMovement(NEWYORK, new Date(3), new Date(4)).
+      build();*/
   }
 
 }

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/infrastructure/persistence/hibernate/CargoRepositoryTest.java

@@ -56,9 +56,9 @@ public class CargoRepositoryTest extends AbstractRepositoryTest {
 
     Voyage hongkongMelbourneTokyoAndBack = new Voyage.Builder(
       new VoyageNumber("0303"), HONGKONG).
-      addMovement(MELBOURNE, new Date(), new Date()).
-      addMovement(TOKYO, new Date(), new Date()).
-      addMovement(HONGKONG, new Date(), new Date()).
+      addMovement(MELBOURNE, new Date(1), new Date(2)).
+      addMovement(TOKYO, new Date(3), new Date(4)).
+      addMovement(HONGKONG, new Date(5), new Date(6)).
       build();
 
     assertHandlingEvent(cargo, secondEvent, LOAD, HONGKONG, 150, 110, hongkongMelbourneTokyoAndBack);

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/scenario/VoyageRescheduledScenarioTest.java

@@ -21,8 +21,8 @@ import static se.citerus.dddsample.tracking.core.domain.model.location.SampleLoc
 import static se.citerus.dddsample.tracking.core.domain.model.voyage.SampleVoyages.*;
 import se.citerus.dddsample.tracking.core.domain.model.voyage.Voyage;
 import se.citerus.dddsample.tracking.core.domain.model.voyage.VoyageNumber;
-import se.citerus.dddsample.tracking.core.infrastructure.persistence.inmemory.TrackingIdGeneratorInMem;
 import se.citerus.dddsample.tracking.core.infrastructure.persistence.inmemory.LocationRepositoryInMem;
+import se.citerus.dddsample.tracking.core.infrastructure.persistence.inmemory.TrackingIdGeneratorInMem;
 
 import java.util.Date;
 
@@ -59,7 +59,7 @@ public class VoyageRescheduledScenarioTest {
     assertThat(cargo.itinerary().loadTimeAt(NEWYORK), is(oldDepartureTime));
 
     // Now voyage2 is rescheduled, the departure from NYC is delayed a few hours.
-    Date newDepartureTime = toDate("2008-10-24", "18:00");
+    Date newDepartureTime = toDate("2008-10-24", "17:00");
     voyage2.departureRescheduled(NEWYORK, newDepartureTime);
 
     // The schedule of voyage2 is updated