com.google.maps.model.DistanceMatrix Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Google Inc. All rights reserved.
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 * ANY KIND, either express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package com.google.maps.model;

import java.io.Serializable;

/**
 * A complete result from a Distance Matrix API call.
 *
 * @see 
 *     Distance Matrix Results
 */
public class DistanceMatrix implements Serializable {

  private static final long serialVersionUID = 1L;

  /**
   * Origin addresses as returned by the API from your original request. These are formatted by the
   * geocoder and localized according to the language parameter passed with the request.
   */
  public final String[] originAddresses;

  /**
   * Destination addresses as returned by the API from your original request. As with {@link
   * #originAddresses}, these are localized if appropriate.
   */
  public final String[] destinationAddresses;

  /**
   * An array of elements, each of which in turn contains a status, duration, and distance element.
   */
  public final DistanceMatrixRow[] rows;

  public DistanceMatrix(
      String[] originAddresses, String[] destinationAddresses, DistanceMatrixRow[] rows) {
    this.originAddresses = originAddresses;
    this.destinationAddresses = destinationAddresses;
    this.rows = rows;
  }

  @Override
  public String toString() {
    return String.format(
        "DistanceMatrix: %d origins x %d destinations, %d rows",
        originAddresses.length, destinationAddresses.length, rows.length);
  }
}