Renamed Location null object to NONE

dddsample/tracking/core/src/main/java/se/citerus/dddsample/tracking/core/domain/model/cargo/Cargo.java

@@ -200,7 +200,7 @@ public class Cargo extends EntitySupport<Cargo,TrackingId> {
    */
   public Location customsClearancePoint() {
     if (itinerary == null) {
-      return Location.UNKNOWN;
+      return Location.NONE;
     } else {
       return customsZone().entryPoint(itinerary.locations());
     }

dddsample/tracking/core/src/main/java/se/citerus/dddsample/tracking/core/domain/model/cargo/Delivery.java

@@ -83,7 +83,7 @@ class Delivery extends ValueObjectSupport<Delivery> {
     if (hasBeenHandled()) {
       return mostRecentHandlingActivity.location();
     } else {
-      return Location.UNKNOWN;
+      return Location.NONE;
     }
   }
 

dddsample/tracking/core/src/main/java/se/citerus/dddsample/tracking/core/domain/model/location/CustomsZone.java

@@ -27,7 +27,7 @@ public class CustomsZone extends EntitySupport<CustomsZone,String> {
    * @param code code
    * @param name name
    */
-  public CustomsZone(final String code, final String name) {
+  CustomsZone(final String code, final String name) {
     Validate.notNull(code, "Code is required");
     Validate.isTrue(VALID_PATTERN.matcher(code).matches(), code + " is not a valid customs zone code (does not match pattern)");
     Validate.notNull(name, "Name is required");
@@ -35,7 +35,7 @@ public class CustomsZone extends EntitySupport<CustomsZone,String> {
     this.code = code.toUpperCase();
     this.name = name;
   }
-
+  
   @Override
   public String identity() {
     return code;

dddsample/tracking/core/src/main/java/se/citerus/dddsample/tracking/core/domain/model/location/Location.java

@@ -11,7 +11,7 @@ import java.util.TimeZone;
  * <p/>
  * It is uniquely identified by a UN Locode.
  */
-public final class Location extends EntitySupport<Location, UnLocode> {
+public class Location extends EntitySupport<Location, UnLocode> {
 
   private final UnLocode unLocode;
   private final String name;
@@ -21,8 +21,8 @@ public final class Location extends EntitySupport<Location, UnLocode> {
   /**
    * Special Location object that marks an unknown location.
    */
-  public static final Location UNKNOWN = new Location(
-    new UnLocode("XXXXX"), "Unknown location", TimeZone.getTimeZone("Zulu"), null
+  public static final Location NONE = new Location(
+    new UnLocode("XXXXX"), "-", TimeZone.getTimeZone("Zulu"), null
   );
 
   /**

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

@@ -55,7 +55,7 @@ public class CargoTest extends TestCase {
 
     assertEquals(NOT_ROUTED, cargo.routingStatus());
     assertEquals(NOT_RECEIVED, cargo.transportStatus());
-    assertEquals(Location.UNKNOWN, cargo.lastKnownLocation());
+    assertEquals(Location.NONE, cargo.lastKnownLocation());
     assertEquals(Voyage.NONE, cargo.currentVoyage());
   }
 
@@ -75,7 +75,6 @@ public class CargoTest extends TestCase {
     };
 
     cargo.specifyNewRoute(acceptOnlyGood);
-
     assertEquals(NOT_ROUTED, cargo.routingStatus());
 
     cargo.assignToRoute(bad);
@@ -109,7 +108,7 @@ public class CargoTest extends TestCase {
   public void testlastKnownLocationUnknownWhenNoEvents() throws Exception {
     Cargo cargo = new Cargo(new TrackingId("XYZ"), new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
-    assertEquals(Location.UNKNOWN, cargo.lastKnownLocation());
+    assertEquals(Location.NONE, cargo.lastKnownLocation());
   }
 
   public void testlastKnownLocationReceived() throws Exception {
@@ -189,49 +188,6 @@ public class CargoTest extends TestCase {
     assertFalse(cargo.isReadyToClaim());
   }
 
-  private Cargo populateCargoReceivedStockholm() throws Exception {
-    final Cargo cargo = setUpCargoWithItinerary(STOCKHOLM, HAMBURG, MELBOURNE);
-    cargo.handled(new HandlingActivity(RECEIVE, STOCKHOLM));
-    return cargo;
-  }
-
-  private Cargo populateCargoClaimedMelbourne() throws Exception {
-    final Cargo cargo = populateCargoOffMelbourne();
-
-    cargo.handled(new HandlingActivity(CLAIM, MELBOURNE));
-    return cargo;
-  }
-
-  private Cargo populateCargoOffHongKong() throws Exception {
-    final Cargo cargo = setUpCargoWithItinerary(STOCKHOLM, HAMBURG, MELBOURNE);
-
-    cargo.handled(new HandlingActivity(LOAD, STOCKHOLM, crazyVoyage));
-    cargo.handled(new HandlingActivity(UNLOAD, HAMBURG, crazyVoyage));
-    cargo.handled(new HandlingActivity(LOAD, HAMBURG, crazyVoyage));
-    cargo.handled(new HandlingActivity(UNLOAD, MELBOURNE, crazyVoyage));
-    return cargo;
-  }
-
-  private Cargo populateCargoOnHamburg() throws Exception {
-    final Cargo cargo = setUpCargoWithItinerary(STOCKHOLM, HAMBURG, MELBOURNE);
-
-    cargo.handled(new HandlingActivity(LOAD, STOCKHOLM, crazyVoyage));
-    cargo.handled(new HandlingActivity(UNLOAD, HAMBURG, crazyVoyage));
-    cargo.handled(new HandlingActivity(LOAD, HAMBURG, crazyVoyage));
-    return cargo;
-  }
-
-  private Cargo populateCargoOffMelbourne() throws Exception {
-    final Cargo cargo = setUpCargoWithItinerary(STOCKHOLM, HAMBURG, MELBOURNE);
-
-    cargo.handled(new HandlingActivity(LOAD, STOCKHOLM, crazyVoyage));
-    cargo.handled(new HandlingActivity(UNLOAD, HAMBURG, crazyVoyage));
-    cargo.handled(new HandlingActivity(LOAD, HAMBURG, crazyVoyage));
-    cargo.handled(new HandlingActivity(UNLOAD, MELBOURNE, crazyVoyage));
-
-    return cargo;
-  }
-
   public void testIsMisdirectedHappyPath() throws Exception {
     Cargo cargo = shanghaiSeattleChicagoOnPacific2AndContinental3();
 
@@ -335,26 +291,12 @@ public class CargoTest extends TestCase {
     assertFalse(cargo.isMisdirected());
   }
 
-  private Cargo shanghaiSeattleChicagoOnPacific2AndContinental3() {
-    Cargo cargo = new Cargo(new TrackingId("CARGO1"), new RouteSpecification(SHANGHAI, CHICAGO, toDate("2009-12-24")));
-
-    // A cargo with no itinerary is not misdirected
-    assertFalse(cargo.isMisdirected());
-
-    Itinerary itinerary = new Itinerary(
-        Leg.deriveLeg(pacific2, SHANGHAI, SEATTLE),
-        Leg.deriveLeg(continental3, SEATTLE, CHICAGO)
-    );
-    cargo.assignToRoute(itinerary);
-    return cargo;
-  }
-
   public void testCustomsClearancePoint() {
     //cargo destination NYC
     final Cargo cargo = new Cargo(new TrackingId("XYZ"),
         new RouteSpecification(SHANGHAI, NEWYORK, new Date()));
 
-    assertThat(cargo.customsClearancePoint(), is(Location.UNKNOWN));
+    assertThat(cargo.customsClearancePoint(), is(Location.NONE));
 
     //SHA-LGB-NYC
     cargo.assignToRoute(new Itinerary(
@@ -395,6 +337,20 @@ public class CargoTest extends TestCase {
 
   }
 
+  private Cargo shanghaiSeattleChicagoOnPacific2AndContinental3() {
+    Cargo cargo = new Cargo(new TrackingId("CARGO1"), new RouteSpecification(SHANGHAI, CHICAGO, toDate("2009-12-24")));
+
+    // A cargo with no itinerary is not misdirected
+    assertFalse(cargo.isMisdirected());
+
+    Itinerary itinerary = new Itinerary(
+        Leg.deriveLeg(pacific2, SHANGHAI, SEATTLE),
+        Leg.deriveLeg(continental3, SEATTLE, CHICAGO)
+    );
+    cargo.assignToRoute(itinerary);
+    return cargo;
+  }
+
   private Cargo setUpCargoWithItinerary(Location origin, Location midpoint, Location destination) {
     Cargo cargo = new Cargo(new TrackingId("CARGO1"), new RouteSpecification(origin, destination, new Date()));
 
@@ -407,4 +363,48 @@ public class CargoTest extends TestCase {
     return cargo;
   }
 
+  private Cargo populateCargoReceivedStockholm() throws Exception {
+    final Cargo cargo = setUpCargoWithItinerary(STOCKHOLM, HAMBURG, MELBOURNE);
+    cargo.handled(new HandlingActivity(RECEIVE, STOCKHOLM));
+    return cargo;
+  }
+
+  private Cargo populateCargoClaimedMelbourne() throws Exception {
+    final Cargo cargo = populateCargoOffMelbourne();
+
+    cargo.handled(new HandlingActivity(CLAIM, MELBOURNE));
+    return cargo;
+  }
+
+  private Cargo populateCargoOffHongKong() throws Exception {
+    final Cargo cargo = setUpCargoWithItinerary(STOCKHOLM, HAMBURG, MELBOURNE);
+
+    cargo.handled(new HandlingActivity(LOAD, STOCKHOLM, crazyVoyage));
+    cargo.handled(new HandlingActivity(UNLOAD, HAMBURG, crazyVoyage));
+    cargo.handled(new HandlingActivity(LOAD, HAMBURG, crazyVoyage));
+    cargo.handled(new HandlingActivity(UNLOAD, MELBOURNE, crazyVoyage));
+    return cargo;
+  }
+
+  private Cargo populateCargoOnHamburg() throws Exception {
+    final Cargo cargo = setUpCargoWithItinerary(STOCKHOLM, HAMBURG, MELBOURNE);
+
+    cargo.handled(new HandlingActivity(LOAD, STOCKHOLM, crazyVoyage));
+    cargo.handled(new HandlingActivity(UNLOAD, HAMBURG, crazyVoyage));
+    cargo.handled(new HandlingActivity(LOAD, HAMBURG, crazyVoyage));
+    return cargo;
+  }
+
+  private Cargo populateCargoOffMelbourne() throws Exception {
+    final Cargo cargo = setUpCargoWithItinerary(STOCKHOLM, HAMBURG, MELBOURNE);
+
+    cargo.handled(new HandlingActivity(LOAD, STOCKHOLM, crazyVoyage));
+    cargo.handled(new HandlingActivity(UNLOAD, HAMBURG, crazyVoyage));
+    cargo.handled(new HandlingActivity(LOAD, HAMBURG, crazyVoyage));
+    cargo.handled(new HandlingActivity(UNLOAD, MELBOURNE, crazyVoyage));
+
+    return cargo;
+  }
+
+
 }

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

@@ -62,7 +62,7 @@ public class DeliveryTest extends TestCase {
     assertEquals(ROUTED, delivery.routingStatus(itinerary, routeSpecification));
     assertEquals(Voyage.NONE, delivery.currentVoyage());
     assertFalse(delivery.onTheGroundAtDestination(routeSpecification));
-    assertEquals(Location.UNKNOWN, delivery.lastKnownLocation());
+    assertEquals(Location.NONE, delivery.lastKnownLocation());
     assertEquals(NOT_RECEIVED, delivery.transportStatus());
     assertTrue(delivery.lastUpdatedOn().before(new Date()));
   }

dddsample/tracking/core/src/test/java/se/citerus/dddsample/tracking/core/domain/model/location/LocationTest.java

@@ -24,8 +24,8 @@ public class LocationTest extends TestCase {
     // Never equal to null
     assertFalse(location.equals(null));
 
-    // Special UNKNOWN location is equal to itself
-    assertTrue(Location.UNKNOWN.equals(Location.UNKNOWN));
+    // Special NONE location is equal to itself
+    assertTrue(Location.NONE.equals(Location.NONE));
 
     try {
       new Location(null, null, null, null);