com.mapbox.api.staticmap.v1.models.StaticPolylineAnnotation 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.staticmap.v1.models;

import static androidx.annotation.RestrictTo.Scope.LIBRARY;
import static com.mapbox.core.utils.ColorUtils.toHexString;

import androidx.annotation.FloatRange;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import androidx.annotation.RestrictTo;
import com.google.auto.value.AutoValue;
import com.mapbox.api.staticmap.v1.MapboxStaticMap;
import com.mapbox.geojson.utils.PolylineUtils;

import java.util.List;

/**
 * Mapbox Static Image API polyline overlay. Building this object allows you to place a line or
 * object on top or within your static map image. The polyline must be encoded with a precision of 5
 * decimal places and can be created using the
 * {@link PolylineUtils#encode(List, int)}.
 *
 * @since 2.1.0
 */
@AutoValue
public abstract class StaticPolylineAnnotation {

  /**
   * Build a new {@link StaticPolylineAnnotation} object.
   *
   * @return a {@link StaticPolylineAnnotation.Builder} object for creating this object
   * @since 3.0.0
   */
  public static Builder builder() {
    return new AutoValue_StaticPolylineAnnotation.Builder();
  }

  /**
   * Used Internally.
   *
   * @return a String representing the marker part of the URL.
   * @since 2.1.0
   */
  @RestrictTo(LIBRARY)
  public String url() {
    StringBuilder sb = new StringBuilder();

    sb.append("path");
    if (strokeWidth() != null) {
      sb.append("-").append(strokeWidth());
    }
    if (strokeColor() != null) {
      sb.append("+").append(strokeColor());
    }
    if (strokeOpacity() != null) {
      sb.append("-").append(strokeOpacity());
    }
    if (fillColor() != null) {
      sb.append("+").append(fillColor());
    }
    if (fillOpacity() != null) {
      sb.append("-").append(fillOpacity());
    }
    sb.append("(").append(polyline()).append(")");
    return sb.toString();
  }

  @Nullable
  abstract Double strokeWidth();

  @Nullable
  abstract String strokeColor();

  @Nullable
  abstract Float strokeOpacity();

  @Nullable
  abstract String fillColor();

  @Nullable
  abstract Float fillOpacity();

  @NonNull
  abstract String polyline();

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

  /**
   * Builder used for passing in custom parameters.
   *
   * @since 2.1.0
   */
  @AutoValue.Builder
  public abstract static class Builder {

    /**
     * Defines the line stroke width for the path.
     *
     * @param strokeWidth a double value defining the stroke width
     * @return this builder for chaining options together
     * @since 2.1.0
     */
    public abstract Builder strokeWidth(@Nullable @FloatRange(from = 0) Double strokeWidth);

    /**
     * Set the line outer stroke color.
     *
     * @param strokeColor string representing hex color for the stroke color
     * @return this builder for chaining options together
     * @since 2.1.0
     */
    public abstract Builder strokeColor(@Nullable String strokeColor);

    /**
     * Set the line outer stroke color.
     *
     * @param red the value of the stroke color
     * @param green the value of the stroke color
     * @param blue the value of the stroke color
     * @return this builder for chaining options together
     * @since 3.1.0
     */
    public Builder strokeColor(int red, int green, int blue) {
      return strokeColor(toHexString(red, green, blue));
    }

    /**
     * Value between 0, completely transparent, and 1, opaque for the line stroke.
     *
     * @param strokeOpacity value between 0 and 1 representing the stroke opacity
     * @return this builder for chaining options together
     * @since 2.1.0
     */
    public abstract Builder strokeOpacity(
      @Nullable @FloatRange(from = 0, to = 1) Float strokeOpacity);

    /**
     * Set the inner line fill color.
     *
     * @param color string representing hex color for the fill color
     * @return this builder for chaining options together
     * @since 2.1.0
     */
    public abstract Builder fillColor(@Nullable String color);

    /**
     * Set the inner line fill color.
     *
     * @param red the value of the fill color
     * @param green the value of the fill color
     * @param blue the value of the fill color
     * @return this builder for chaining options together
     * @since 3.1.0
     */
    public Builder fillColor(int red, int green, int blue) {
      return fillColor(toHexString(red, green, blue));
    }

    /**
     * Value between 0, completely transparent, and 1, opaque for the line fill.
     *
     * @param fillOpacity value between 0 and 1 representing the fill opacity
     * @return this builder for chaining options together
     * @since 2.1.0
     */
    public abstract Builder fillOpacity(@Nullable @FloatRange(from = 0, to = 1) Float fillOpacity);

    /**
     * The current polyline string being used for the paths geometry. You can use
     * {@link PolylineUtils#decode(String, int)} to decode the string using
     * precision 5.
     *
     * @param polyline a String containing the paths geometry information
     * @return this builder for chaining options together
     * @since 2.1.0
     */
    public abstract Builder polyline(@NonNull String polyline);

    /**
     * This uses the provided parameters set using the {@link Builder} and creates a new
     * {@link StaticMarkerAnnotation} object which can be passed into the {@link MapboxStaticMap}
     * request.
     *
     * @return a new instance of {@link StaticPolylineAnnotation}
     * @since 2.1.0
     */
    public abstract StaticPolylineAnnotation build();
  }
}