com.mapbox.api.directions.v5.models.DirectionsError Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mapbox-sdk-services Show documentation
Mapbox Java SDK
There is a newer version: 5.9.0-alpha.1
package com.mapbox.api.directions.v5.models;

import android.support.annotation.Nullable;
import com.google.auto.value.AutoValue;
import com.google.gson.Gson;
import com.google.gson.TypeAdapter;

import java.io.Serializable;

/**
 * If an InvalidInput error is thrown, this class can be used to get both the code and the message
 * which holds an explanation of the invalid input.
 *
 * @since 3.0.0
 */
@AutoValue
public abstract class DirectionsError implements Serializable {

  /**
   * Create a new instance of this class by using the {@link Builder} class.
   *
   * @return this classes {@link Builder} for creating a new instance
   * @since 3.0.0
   */
  public static Builder builder() {
    return new AutoValue_DirectionsError.Builder();
  }

  /**
   * String indicating the state of the response. This is a separate code than the HTTP status code.
   * On normal valid responses, the value will be Ok. The possible responses are listed below:
   * 
   * Ok:200 Normal success case
   * NoRoute: 200 There was no route found for the given coordinates. Check
   * for impossible routes (e.g. routes over oceans without ferry connections).
   * NoSegment: 200 No road segment could be matched for coordinates. Check for
   * coordinates too far away from a road.
   * ProfileNotFound: 404 Use a valid profile as described above
   * InvalidInput: 422
   * 
   *
   * @return a string with one of the given values described in the list above
   * @since 3.0.0
   */
  @Nullable
  public abstract String code();

  /**
   * Provides a short message with the explanation of the invalid input.
   *
   * @return a string containing the message API Directions response
   * @since 3.0.0
   */
  @Nullable
  public abstract String message();

  /**
   * Convert the current {@link DirectionsError} to its builder holding the currently assigned
   * values. This allows you to modify a single property and then rebuild the object resulting in
   * an updated and modified {@link DirectionsError}.
   *
   * @return a {@link DirectionsError.Builder} with the same values set to match the ones defined
   *   in this {@link DirectionsError}
   * @since 3.1.0
   */
  public abstract Builder toBuilder();

  /**
   * Gson type adapter for parsing Gson to this class.
   *
   * @param gson the built {@link Gson} object
   * @return the type adapter for this class
   * @since 3.0.0
   */
  public static TypeAdapter typeAdapter(Gson gson) {
    return new AutoValue_DirectionsError.GsonTypeAdapter(gson);
  }

  /**
   * This builder can be used to set the values describing the {@link DirectionsError}.
   *
   * @since 3.0.0
   */
  @AutoValue.Builder
  public abstract static class Builder {

    /**
     * String indicating the state of the response. This is a separate code than the HTTP status
     * code. On normal valid responses, the value will be Ok. The possible responses are listed
     * below:
     * 
     * Ok:200 Normal success case
     * NoRoute: 200 There was no route found for the given coordinates. Check
     * for impossible routes (e.g. routes over oceans without ferry connections).
     * NoSegment: 200 No road segment could be matched for coordinates. Check
     * for coordinates too far away from a road.
     * ProfileNotFound: 404 Use a valid profile as described above
     * InvalidInput: 422
     * 
     *
     * @param code a string with one of the given values described in the list above
     * @return this builder for chaining options together
     * @since 3.0.0
     */
    public abstract Builder code(String code);

    /**
     * Provides a short message with the explanation of the invalid input.
     *
     * @param message a string containing the message API Directions response
     * @return this builder for chaining options together
     * @since 3.0.0
     */
    public abstract Builder message(String message);

    /**
     * Build a new {@link DirectionsError} object.
     *
     * @return a new {@link DirectionsError} using the provided values in this builder
     * @since 3.0.0
     */
    public abstract DirectionsError build();
  }
}