Merge pull request #452 from apjanke/model-value-based-toStrings

Add value-based toString()s for model objects

Author: domesticmouse

src/main/java/com/google/maps/internal/StringJoin.java

@@ -15,6 +15,8 @@
 
 package com.google.maps.internal;
 
+import java.util.Objects;
+
 /** Utility class to join strings. */
 public class StringJoin {
 
@@ -30,6 +32,10 @@ public interface UrlValue {
   private StringJoin() {}
 
   public static String join(char delim, String... parts) {
+    return join(new String(new char[] {delim}), parts);
+  }
+
+  public static String join(CharSequence delim, String... parts) {
     StringBuilder result = new StringBuilder();
     for (int i = 0; i < parts.length; i++) {
       if (i != 0) {
@@ -40,6 +46,21 @@ public static String join(char delim, String... parts) {
     return result.toString();
   }
 
+  public static String join(char delim, Object... parts) {
+    return join(new String(new char[] {delim}), parts);
+  }
+
+  public static String join(CharSequence delim, Object... parts) {
+    StringBuilder result = new StringBuilder();
+    for (int i = 0; i < parts.length; i++) {
+      if (i != 0) {
+        result.append(delim);
+      }
+      result.append(Objects.toString(parts[i]));
+    }
+    return result.toString();
+  }
+
   public static String join(char delim, UrlValue... parts) {
     String[] strings = new String[parts.length];
     int i = 0;

src/main/java/com/google/maps/model/AddressComponent.java

@@ -15,6 +15,8 @@
 
 package com.google.maps.model;
 
+import static com.google.maps.internal.StringJoin.join;
+
 import java.io.Serializable;
 
 /**
@@ -41,4 +43,15 @@ public class AddressComponent implements Serializable {
 
   /** Indicates the type of each part of the address. Examples include street number or country. */
   public AddressComponentType[] types;
+
+  public String toString() {
+    StringBuilder sb = new StringBuilder("[AddressComponent: ");
+    sb.append("\"").append(longName).append("\"");
+    if (shortName != null) {
+      sb.append(" (\"").append(shortName).append("\")");
+    }
+    sb.append(" (").append(join(", ", (Object[]) types)).append(")");
+    sb.append("]");
+    return sb.toString();
+  }
 }

src/main/java/com/google/maps/model/AutocompletePrediction.java

@@ -16,6 +16,8 @@
 package com.google.maps.model;
 
 import java.io.Serializable;
+import java.util.Arrays;
+import java.util.Objects;
 
 /**
  * Represents a single Autocomplete result returned from the Google Places API Web Service.
@@ -61,6 +63,10 @@ public static class MatchedSubstring {
 
     /** The start position of the matched substring, measured in Unicode characters. */
     public int offset;
+
+    public String toString() {
+      return String.format("(offset=%d, length=%d)", offset, length);
+    }
   }
 
   /**
@@ -83,5 +89,21 @@ public static class Term {
 
     /** The text of the matched term. */
     public String value;
+
+    public String toString() {
+      return String.format("(offset=%d, value=%s)", offset, value);
+    }
+  }
+
+  public String toString() {
+    return String.format(
+        "[AutocompletePrediction: \"%s\", placeId=%s, types=%s, terms=%s, "
+            + "matchedSubstrings=%s, structuredFormatting=%s]",
+        description,
+        placeId,
+        Arrays.toString(types),
+        Arrays.toString(terms),
+        Arrays.toString(matchedSubstrings),
+        Objects.toString(structuredFormatting));
   }
 }

src/main/java/com/google/maps/model/AutocompleteStructuredFormatting.java

@@ -16,6 +16,7 @@
 package com.google.maps.model;
 
 import java.io.Serializable;
+import java.util.Arrays;
 
 /** The structured formatting info for a {@link com.google.maps.model.AutocompletePrediction}. */
 public class AutocompleteStructuredFormatting implements Serializable {
@@ -30,4 +31,15 @@ public class AutocompleteStructuredFormatting implements Serializable {
 
   /** The secondary text of a prediction, usually the location of the place. */
   public String secondaryText;
+
+  public String toString() {
+    StringBuilder sb = new StringBuilder("(");
+    sb.append("\"").append(mainText).append("\"");
+    sb.append(" at ").append(Arrays.toString(mainTextMatchedSubstrings));
+    if (secondaryText != null) {
+      sb.append(", secondaryText=\"").append(secondaryText).append("\"");
+    }
+    sb.append(")");
+    return sb.toString();
+  }
 }

src/main/java/com/google/maps/model/Bounds.java

@@ -25,4 +25,8 @@ public class Bounds implements Serializable {
   public LatLng northeast;
   /** The southwest corner of the bounding box. */
   public LatLng southwest;
+
+  public String toString() {
+    return String.format("[%s, %s]", northeast, southwest);
+  }
 }

src/main/java/com/google/maps/model/CellTower.java

@@ -79,6 +79,19 @@ private CellTower(
   /** The timing advance value. */
   public Integer timingAdvance = null;
 
+  public String toString() {
+    return String.format(
+        "[CellTower: cellId=%s, locationAreaCode=%s, mobileCountryCode=%s, "
+            + "mobileNetworkCode=%s, age=%s, signalStrength=%s, timingAdvance=%s]",
+        cellId,
+        locationAreaCode,
+        mobileCountryCode,
+        mobileNetworkCode,
+        age,
+        signalStrength,
+        timingAdvance);
+  }
+
   public static class CellTowerBuilder {
     private Integer _cellId = null;
     private Integer _locationAreaCode = null;

src/main/java/com/google/maps/model/DirectionsLeg.java

@@ -93,4 +93,25 @@ public class DirectionsLeg implements Serializable {
    * leg.
    */
   public String endAddress;
+
+  public String toString() {
+    StringBuilder sb =
+        new StringBuilder(
+            String.format(
+                "[DirectionsLeg: \"%s\" -> \"%s\" (%s -> %s)",
+                startAddress, endAddress, startLocation, endLocation));
+    if (departureTime != null) {
+      sb.append(", departureTime=").append(departureTime);
+    }
+    if (arrivalTime != null) {
+      sb.append(", arrivalTime=").append(arrivalTime);
+    }
+    if (durationInTraffic != null) {
+      sb.append(", durationInTraffic=").append(durationInTraffic);
+    }
+    sb.append(", duration=").append(duration);
+    sb.append(", distance=").append(distance);
+    sb.append(": ").append(steps.length).append(" steps]");
+    return sb.toString();
+  }
 }

src/main/java/com/google/maps/model/DirectionsRoute.java

@@ -16,6 +16,7 @@
 package com.google.maps.model;
 
 import java.io.Serializable;
+import java.util.Arrays;
 
 /**
  * A Directions API result. When the Directions API returns results, it places them within a routes
@@ -71,4 +72,19 @@ public class DirectionsRoute implements Serializable {
    * warnings yourself.
    */
   public String[] warnings;
+
+  public String toString() {
+    String str =
+        String.format(
+            "[DirectionsRoute: \"%s\", %d legs, waypointOrder=%s, bounds=%s",
+            summary, legs.length, Arrays.toString(waypointOrder), bounds);
+    if (fare != null) {
+      str = str + ", fare=" + fare;
+    }
+    if (warnings != null && warnings.length > 0) {
+      str = str + ", " + warnings.length + " warnings";
+    }
+    str = str + "]";
+    return str;
+  }
 }

src/main/java/com/google/maps/model/DirectionsStep.java

@@ -84,4 +84,19 @@ public class DirectionsStep implements Serializable {
    * Details</a> for more detail.
    */
   public TransitDetails transitDetails;
+
+  public String toString() {
+    StringBuilder sb = new StringBuilder("[DirectionsStep: ");
+    sb.append("\"").append(htmlInstructions).append("\"");
+    sb.append(String.format(" (%s -> %s", startLocation, endLocation)).append(")");
+    sb.append(" ").append(travelMode);
+    sb.append(", duration=").append(duration);
+    sb.append(", distance=").append(distance);
+    sb.append(", ").append(steps.length).append(" steps");
+    if (transitDetails != null) {
+      sb.append(", transitDetails=").append(transitDetails);
+    }
+    sb.append("]");
+    return sb.toString();
+  }
 }

src/main/java/com/google/maps/model/DistanceMatrix.java

@@ -51,4 +51,10 @@ public DistanceMatrix(
     this.destinationAddresses = destinationAddresses;
     this.rows = rows;
   }
+
+  public String toString() {
+    return String.format(
+        "DistanceMatrix: %d origins x %d destinations, %d rows",
+        originAddresses.length, destinationAddresses.length, rows.length);
+  }
 }