A few checkstyle report fixes - only ~1200 errors to go!

Moved DDD pattern interfaces to doman.shared

dddsample/pom.xml

@@ -356,6 +356,8 @@
         <artifactId>maven-checkstyle-plugin</artifactId>
         <configuration>
           <configLocation>checkstyle.xml</configLocation>
+          <!-- Java source code generated from WSDL -->
+          <excludes>**/com/aggregator/**/*</excludes>
         </configuration>
       </plugin>
     </plugins>

dddsample/src/main/java/com/pathfinder/api/GraphTraversalService.java

@@ -8,10 +8,19 @@ import java.util.Properties;
 /**
  * Part of the external graph traversal API exposed by the routing team
  * and used by us (booking and tracking team).
- * 
+ *
  */
 public interface GraphTraversalService extends Remote {
 
-  List<TransitPath> findShortestPath(String originUnLocode, String destinationUnLocode, Properties limitations) throws RemoteException;
+  /**
+   * @param originUnLocode origin UN Locode
+   * @param destinationUnLocode destination UN Locode
+   * @param limitations restrictions on the path selection, as key-value according to some API specification
+   * @return A list of transit paths
+   * @throws RemoteException RMI problem
+   */
+  List<TransitPath> findShortestPath(String originUnLocode,
+                                     String destinationUnLocode,
+                                     Properties limitations) throws RemoteException;
 
-}
+}

dddsample/src/main/java/se/citerus/dddsample/application/BookingService.java

@@ -24,9 +24,9 @@ public interface BookingService {
 
   /**
    * Requests a list of itineraries describing possible routes for this cargo.
-   * 
+   *
    * @param trackingId cargo tracking id
-   * @return A list of possible itineraries for this cargo 
+   * @return A list of possible itineraries for this cargo
    */
   List<Itinerary> requestPossibleRoutesForCargo(TrackingId trackingId);
 

dddsample/src/main/java/se/citerus/dddsample/application/util/DateTestUtil.java

@@ -8,18 +8,32 @@ import java.util.Date;
  * A few utils for working with Date in tests.
  *
  */
-public class DateTestUtil {
+public final class DateTestUtil {
 
-  public static Date toDate(String date) {
+  /**
+   * @param date date string as yyyy-MM-dd
+   * @return Date representation
+   */
+  public static Date toDate(final String date) {
     return toDate(date, "00:00.00.000");
   }
 
-  public static Date toDate(String date, String time) {
+  /**
+   * @param date date string as yyyy-MM-dd
+   * @param time time string as HH:mm
+   * @return Date representation
+   */
+  public static Date toDate(final String date, final String time) {
     try {
-      return new SimpleDateFormat("yyyy-MM-dd hh:mm").parse(date + " " + time);
+      return new SimpleDateFormat("yyyy-MM-dd HH:mm").parse(date + " " + time);
     } catch (ParseException e) {
       throw new RuntimeException(e);
     }
   }
 
+  /**
+   * Prevent instantiation.
+   */
+  private DateTestUtil() {
+  }
 }

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

@@ -1,11 +1,11 @@
 package se.citerus.dddsample.domain.model.cargo;
 
 import org.apache.commons.lang.Validate;
-import se.citerus.dddsample.domain.model.Entity;
 import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import se.citerus.dddsample.domain.model.handling.HandlingHistory;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.shared.DomainObjectUtils;
+import se.citerus.dddsample.domain.shared.Entity;
 
 /**
  * A Cargo. This is the central class in the domain model,
@@ -61,7 +61,9 @@ public class Cargo implements Entity<Cargo> {
     this.origin = routeSpecification.origin();
     this.routeSpecification = routeSpecification;
 
-    this.delivery = Delivery.derivedFrom(this.routeSpecification, this.itinerary, HandlingHistory.EMPTY);
+    this.delivery = Delivery.derivedFrom(
+      this.routeSpecification, this.itinerary, HandlingHistory.EMPTY
+    );
   }
 
   /**
@@ -140,9 +142,11 @@ public class Cargo implements Entity<Cargo> {
    * but changes to the delivery history (when a cargo is handled) cause the status update
    * to happen <b>asynchronously</b> since {@link HandlingEvent} is in a different aggregate.
    *
-   * @param handlingHistory delivery history
+   * @param handlingHistory handling history
    */
   public void deriveDeliveryProgress(final HandlingHistory handlingHistory) {
+    // TODO filter events on cargo (must be same as this cargo)
+
     // Delivery is a value object, so we can simply discard the old one
     // and replace it with a new
     this.delivery = Delivery.derivedFrom(routeSpecification(), itinerary(), handlingHistory);

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/CargoRepository.java

@@ -31,6 +31,4 @@ public interface CargoRepository {
    */
   TrackingId nextTrackingId();
 
-  // TODO perhaps it belongs in a factory instead
-
 }

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

@@ -3,7 +3,6 @@ package se.citerus.dddsample.domain.model.cargo;
 import org.apache.commons.lang.Validate;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
-import se.citerus.dddsample.domain.model.ValueObject;
 import static se.citerus.dddsample.domain.model.cargo.RoutingStatus.*;
 import static se.citerus.dddsample.domain.model.cargo.TransportStatus.*;
 import se.citerus.dddsample.domain.model.handling.HandlingEvent;
@@ -11,6 +10,7 @@ import se.citerus.dddsample.domain.model.handling.HandlingHistory;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.voyage.Voyage;
 import se.citerus.dddsample.domain.shared.DomainObjectUtils;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.Date;
 import java.util.Iterator;

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/HandlingActivity.java

@@ -3,10 +3,10 @@ package se.citerus.dddsample.domain.model.cargo;
 import org.apache.commons.lang.Validate;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
-import se.citerus.dddsample.domain.model.ValueObject;
 import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.voyage.Voyage;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 /**
  * A handling activity represents how and where a cargo can be handled,

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/Itinerary.java

@@ -1,9 +1,9 @@
 package se.citerus.dddsample.domain.model.cargo;
 
 import org.apache.commons.lang.Validate;
-import se.citerus.dddsample.domain.model.ValueObject;
 import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import se.citerus.dddsample.domain.model.location.Location;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.Collections;
 import java.util.Date;

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/Leg.java

@@ -3,9 +3,9 @@ package se.citerus.dddsample.domain.model.cargo;
 import org.apache.commons.lang.Validate;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
-import se.citerus.dddsample.domain.model.ValueObject;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.voyage.Voyage;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.Date;
 

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/RouteSpecification.java

@@ -3,9 +3,9 @@ package se.citerus.dddsample.domain.model.cargo;
 import org.apache.commons.lang.Validate;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
-import se.citerus.dddsample.domain.model.ValueObject;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.shared.AbstractSpecification;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.Date;
 

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/RoutingStatus.java

@@ -1,6 +1,6 @@
 package se.citerus.dddsample.domain.model.cargo;
 
-import se.citerus.dddsample.domain.model.ValueObject;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 /**
  * Routing status. 

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/TrackingId.java

@@ -1,7 +1,7 @@
 package se.citerus.dddsample.domain.model.cargo;
 
 import org.apache.commons.lang.Validate;
-import se.citerus.dddsample.domain.model.ValueObject;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 /**
  * Uniquely identifies a particular cargo. Automatically generated by the application.

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/TransportStatus.java

@@ -1,6 +1,6 @@
 package se.citerus.dddsample.domain.model.cargo;
 
-import se.citerus.dddsample.domain.model.ValueObject;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 /**
  * Represents the different transport statuses for a cargo.

dddsample/src/main/java/se/citerus/dddsample/domain/model/handling/HandlingEvent.java

@@ -5,12 +5,12 @@ import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
 import org.apache.commons.lang.builder.ToStringBuilder;
 import org.apache.commons.lang.builder.ToStringStyle;
-import se.citerus.dddsample.domain.model.DomainEvent;
-import se.citerus.dddsample.domain.model.ValueObject;
 import se.citerus.dddsample.domain.model.cargo.Cargo;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.voyage.Voyage;
+import se.citerus.dddsample.domain.shared.DomainEvent;
 import se.citerus.dddsample.domain.shared.DomainObjectUtils;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.Date;
 

dddsample/src/main/java/se/citerus/dddsample/domain/model/handling/HandlingHistory.java

@@ -1,7 +1,7 @@
 package se.citerus.dddsample.domain.model.handling;
 
 import org.apache.commons.lang.Validate;
-import se.citerus.dddsample.domain.model.ValueObject;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.*;
 import static java.util.Collections.sort;

dddsample/src/main/java/se/citerus/dddsample/domain/model/handling/UnknownCargoException.java

@@ -9,10 +9,16 @@ public final class UnknownCargoException extends CannotCreateHandlingEventExcept
 
   private final TrackingId trackingId;
 
+  /**
+   * @param trackingId cargo tracking id
+   */
   public UnknownCargoException(final TrackingId trackingId) {
     this.trackingId = trackingId;
   }
 
+  /**
+   * {@inheritDoc}
+   */            
   @Override
   public String getMessage() {
     return "No cargo with tracking id " + trackingId.idString() + " exists in the system";

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

@@ -1,7 +1,7 @@
 package se.citerus.dddsample.domain.model.location;
 
 import org.apache.commons.lang.Validate;
-import se.citerus.dddsample.domain.model.Entity;
+import se.citerus.dddsample.domain.shared.Entity;
 
 /**
  * A location is our model is stops on a journey, such as cargo

dddsample/src/main/java/se/citerus/dddsample/domain/model/location/UnLocode.java

@@ -1,7 +1,7 @@
 package se.citerus.dddsample.domain.model.location;
 
 import org.apache.commons.lang.Validate;
-import se.citerus.dddsample.domain.model.ValueObject;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.regex.Pattern;
 

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

@@ -3,8 +3,8 @@ package se.citerus.dddsample.domain.model.voyage;
 import org.apache.commons.lang.Validate;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
-import se.citerus.dddsample.domain.model.ValueObject;
 import se.citerus.dddsample.domain.model.location.Location;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.Date;
 

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

@@ -2,7 +2,7 @@ package se.citerus.dddsample.domain.model.voyage;
 
 import org.apache.commons.lang.Validate;
 import org.apache.commons.lang.builder.HashCodeBuilder;
-import se.citerus.dddsample.domain.model.ValueObject;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 import java.util.Collections;
 import java.util.List;

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

@@ -1,8 +1,8 @@
 package se.citerus.dddsample.domain.model.voyage;
 
 import org.apache.commons.lang.Validate;
-import se.citerus.dddsample.domain.model.Entity;
 import se.citerus.dddsample.domain.model.location.Location;
+import se.citerus.dddsample.domain.shared.Entity;
 
 import java.util.ArrayList;
 import java.util.Date;

dddsample/src/main/java/se/citerus/dddsample/domain/model/voyage/VoyageNumber.java

@@ -1,7 +1,7 @@
 package se.citerus.dddsample.domain.model.voyage;
 
 import org.apache.commons.lang.Validate;
-import se.citerus.dddsample.domain.model.ValueObject;
+import se.citerus.dddsample.domain.shared.ValueObject;
 
 /**
  * Identifies a voyage.

dddsample/src/main/java/se/citerus/dddsample/domain/model/DomainEvent.java → dddsample/src/main/java/se/citerus/dddsample/domain/shared/DomainEvent.java

@@ -1,4 +1,4 @@
-package se.citerus.dddsample.domain.model;
+package se.citerus.dddsample.domain.shared;
 
 /**
  * A domain event is something that is unique, but does not have a lifecycle.

dddsample/src/main/java/se/citerus/dddsample/domain/shared/DomainObjectUtils.java

@@ -5,7 +5,26 @@ package se.citerus.dddsample.domain.shared;
  *
  */
 public class DomainObjectUtils {
+
+  /**
+   * @param actual actual value
+   * @param safe a null-safe value
+   * @param <T> type
+   * @return actual value, if it's not null, or safe value if the actual value is null.
+   */
   public static <T> T nullSafe(T actual, T safe) {
     return actual == null ? safe : actual;
   }
+
+  // TODO wrappers for some of the commons-lang code:
+  //
+  // EqualsBuilder that uses sameIdentity/sameValue,
+  // better validation (varargs etc) 
+
+  /**
+   * Prevent instantiation.
+   */
+  private DomainObjectUtils() {
+  }
+
 }

dddsample/src/main/java/se/citerus/dddsample/domain/model/Entity.java → dddsample/src/main/java/se/citerus/dddsample/domain/shared/Entity.java

@@ -1,4 +1,4 @@
-package se.citerus.dddsample.domain.model;
+package se.citerus.dddsample.domain.shared;
 
 /**
  * An entity, as explained in the DDD book.

dddsample/src/main/java/se/citerus/dddsample/domain/model/ValueObject.java → dddsample/src/main/java/se/citerus/dddsample/domain/shared/ValueObject.java

@@ -1,4 +1,4 @@
-package se.citerus.dddsample.domain.model;
+package se.citerus.dddsample.domain.shared;
 
 import java.io.Serializable;
 

dddsample/src/main/java/se/citerus/dddsample/interfaces/booking/facade/internal/assembler/CargoRoutingDTOAssembler.java

@@ -10,6 +10,11 @@ import se.citerus.dddsample.interfaces.booking.facade.dto.CargoRoutingDTO;
  */
 public class CargoRoutingDTOAssembler {
 
+  /**
+   *
+   * @param cargo cargo
+   * @return A cargo routing DTO
+   */
   public CargoRoutingDTO toDTO(final Cargo cargo) {
     final CargoRoutingDTO dto = new CargoRoutingDTO(
       cargo.trackingId().idString(),

dddsample/src/main/java/se/citerus/dddsample/interfaces/booking/facade/internal/assembler/ItineraryCandidateDTOAssembler.java

@@ -18,7 +18,11 @@ import java.util.List;
  * Assembler class for the ItineraryCandidateDTO.
  */
 public class ItineraryCandidateDTOAssembler {
-  
+
+  /**
+   * @param itinerary itinerary
+   * @return A route candidate DTO
+   */
   public RouteCandidateDTO toDTO(final Itinerary itinerary) {
     final List<LegDTO> legDTOs = new ArrayList<LegDTO>(itinerary.legs().size());
     for (Leg leg : itinerary.legs()) {
@@ -27,6 +31,10 @@ public class ItineraryCandidateDTOAssembler {
     return new RouteCandidateDTO(legDTOs);
   }
 
+  /**
+   * @param leg leg
+   * @return A leg DTO
+   */
   protected LegDTO toLegDTO(final Leg leg) {
     final VoyageNumber voyageNumber = leg.voyage().voyageNumber();
     final UnLocode from = leg.loadLocation().unLocode();
@@ -34,7 +42,15 @@ public class ItineraryCandidateDTOAssembler {
     return new LegDTO(voyageNumber.idString(), from.idString(), to.idString(), leg.loadTime(), leg.unloadTime());
   }
 
-  public Itinerary fromDTO(RouteCandidateDTO routeCandidateDTO, VoyageRepository voyageRepository, LocationRepository locationRepository) {
+  /**
+   * @param routeCandidateDTO route candidate DTO
+   * @param voyageRepository voyage repository
+   * @param locationRepository location repository
+   * @return An itinerary
+   */
+  public Itinerary fromDTO(final RouteCandidateDTO routeCandidateDTO,
+                           final VoyageRepository voyageRepository,
+                           final LocationRepository locationRepository) {
     final List<Leg> legs = new ArrayList<Leg>(routeCandidateDTO.getLegs().size());
     for (LegDTO legDTO : routeCandidateDTO.getLegs()) {
       final VoyageNumber voyageNumber = new VoyageNumber(legDTO.getVoyageNumber());