Turn lane attributes for vehicle type accessibility (#1608)

* Support for IntersectionLane attributes

* Changelog

Author: DzmitryFomchyn

CHANGELOG.md

@@ -4,6 +4,8 @@ Mapbox welcomes participation and contributions from everyone.
 
 ### main
 
+- Added `IntersectionLanes#access` property which provides lane access attributes, such as allowed vehicle types for designated lanes. [#1608](https://github.com/mapbox/mapbox-java/pull/1608)
+
 ### v7.3.2 - March 13, 2025
 
 - Updated `auto-value-gson` to version [0.0.2](https://github.com/mapbox/auto-value-gson/releases/tag/mapbox-v0.0.2). [#1605](https://github.com/mapbox/mapbox-java/pull/1605)

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/InterningStringAdapter.java

@@ -0,0 +1,25 @@
+package com.mapbox.api.directions.v5.models;
+
+import com.google.gson.TypeAdapter;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonToken;
+import com.google.gson.stream.JsonWriter;
+
+import java.io.IOException;
+
+class InterningStringAdapter extends TypeAdapter<String> {
+
+  @Override
+  public void write(JsonWriter out, String value) throws IOException {
+    out.value(value);
+  }
+
+  @Override
+  public String read(JsonReader in) throws IOException {
+    if (in.peek() == JsonToken.NULL) {
+      in.nextNull();
+      return null;
+    }
+    return in.nextString().intern();
+  }
+}

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/IntersectionLaneAccess.java

@@ -0,0 +1,153 @@
+package com.mapbox.api.directions.v5.models;
+
+import androidx.annotation.Nullable;
+import androidx.annotation.StringDef;
+
+import com.google.auto.value.AutoValue;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.mapbox.api.directions.v5.DirectionsAdapterFactory;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.util.List;
+
+/**
+ * Object representing lane access attributes.
+ */
+@AutoValue
+public abstract class IntersectionLaneAccess extends DirectionsJsonObject {
+
+  /**
+   * Indicates lanes that is designated to bicycles.
+   */
+  public static final String BICYCLE = "bicycle";
+
+  /**
+   * Indicates lanes that is designated to buses.
+   */
+  public static final String BUS = "bus";
+
+  /**
+   * Indicates High-occupancy vehicle lanes.
+   */
+  public static final String HOV = "hov";
+
+  /**
+   * Indicates lanes that is designated to mopeds.
+   */
+  public static final String MOPED = "moped";
+
+  /**
+   * Indicates lanes that is designated to motorcycles.
+   */
+  public static final String MOTORCYCLE = "motorcycle";
+
+  /**
+   * Indicates lanes that is designated to taxis.
+   */
+  public static final String TAXI = "taxi";
+
+  /**
+   * Represents the allowed vehicle types for a designated lane.
+   */
+  @Retention(RetentionPolicy.CLASS)
+  @StringDef({
+    BICYCLE,
+    BUS,
+    HOV,
+    MOPED,
+    MOTORCYCLE,
+    TAXI
+  })
+  public @interface LaneDesignatedVehicleType {
+  }
+
+  /**
+   * Indicates whether a lane is designated to specified vehicle types.
+   * A vehicle type can be any of (but not limited to) the predefined constants in
+   * {@link LaneDesignatedVehicleType}, such as {@link #BICYCLE},
+   * {@link #BUS}, {@link #HOV}, {@link #MOPED}, {@link #MOTORCYCLE}, or {@link #TAXI}.
+   * For example, when a lane is designated to buses and taxis, this list should have
+   * {@link #BUS} and {@link #TAXI} as its values.
+   *
+   * @return a list of vehicle types for which this lane is designated
+   * @see LaneDesignatedVehicleType
+   */
+  @Nullable
+  @SerializedName("designated")
+  public abstract List<String> designated();
+
+  /**
+   * Convert the current {@link IntersectionLaneAccess} 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 IntersectionLaneAccess}.
+   *
+   * @return a {@link IntersectionLaneAccess.Builder} with the same values set to match the ones
+   *   defined in this {@link IntersectionLaneAccess}
+   */
+  public abstract IntersectionLaneAccess.Builder toBuilder();
+
+  /**
+   * Create a new instance of this class by using the {@link IntersectionLaneAccess.Builder} class.
+   *
+   * @return this classes {@link IntersectionLaneAccess.Builder} for creating a new instance
+   */
+  public static IntersectionLaneAccess.Builder builder() {
+    return new AutoValue_IntersectionLaneAccess.Builder();
+  }
+
+  /**
+   * Gson type adapter for parsing Gson to this class.
+   *
+   * @param gson the built {@link Gson} object
+   * @return the type adapter for this class
+   */
+  public static TypeAdapter<IntersectionLaneAccess> typeAdapter(Gson gson) {
+    final Gson customGson = gson.newBuilder()
+      .registerTypeAdapter(String.class, new InterningStringAdapter())
+      .create();
+    return new AutoValue_IntersectionLaneAccess.GsonTypeAdapter(customGson);
+  }
+
+  /**
+   * Create a new instance of this class by passing in a formatted valid JSON String.
+   *
+   * @param json a formatted valid JSON string defining an IntersectionLaneAccess
+   * @return a new instance of this class defined by the values passed inside this static factory
+   *   method
+   */
+  public static IntersectionLaneAccess fromJson(String json) {
+    GsonBuilder gson = new GsonBuilder();
+    gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
+    return gson.create().fromJson(json, IntersectionLaneAccess.class);
+  }
+
+  /**
+   * This builder can be used to set the values describing the {@link IntersectionLaneAccess}.
+   */
+  @AutoValue.Builder
+  public abstract static class Builder extends
+    DirectionsJsonObject.Builder<IntersectionLaneAccess.Builder> {
+
+    /**
+     * Provide a list of vehicle types for which this lane is designated. A vehicle type can be
+     * any of (but not limited to) the predefined constants in
+     * {@link LaneDesignatedVehicleType}, such as {@link #BICYCLE}, {@link #BUS}, {@link #HOV},
+     * {@link #MOPED}, {@link #MOTORCYCLE}, or {@link #TAXI}
+     *
+     * @param designated a list of vehicle types for which this lane is designated.
+     * @return this builder for chaining options together
+     */
+    public abstract IntersectionLaneAccess.Builder designated(@Nullable List<String> designated);
+
+    /**
+     * Build a new {@link IntersectionLaneAccess} object.
+     *
+     * @return a new {@link IntersectionLaneAccess} using the provided values in this builder
+     */
+    public abstract IntersectionLaneAccess build();
+  }
+}

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/IntersectionLanes.java

@@ -7,6 +7,7 @@
 import com.google.gson.TypeAdapter;
 import com.google.gson.annotations.SerializedName;
 import com.mapbox.api.directions.v5.DirectionsAdapterFactory;
+import com.mapbox.api.directions.v5.DirectionsCriteria.PaymentMethodsCriteria;
 
 import java.util.List;
 
@@ -72,24 +73,33 @@ public static Builder builder() {
   /**
    * Array that can be made up of multiple signs such as {@code left}, {@code right}, etc.
    *
-   * @return Array of signs for each turn lane. There can be multiple signs. For example, a turning
+   * @return List of signs for each turn lane. There can be multiple signs. For example, a turning
    *   lane can have a sign with an arrow pointing left and another sign with an arrow pointing
    *   straight.
    * @since 2.0.0
    */
   @Nullable
   public abstract List<String> indications();
 
-  /*
+  /**
    * Available payment methods for the lane.
    * @return A list of strings where each value
-   *         matches {@link DirectionsCriteria.PaymentMethodsCriteria}
+   *         matches {@link PaymentMethodsCriteria}
    */
-  @SuppressWarnings("checkstyle:javadocmethod")
   @Nullable
   @SerializedName("payment_methods")
   public abstract List<String> paymentMethods();
 
+  /**
+   * A {@link IntersectionLaneAccess} object representing the access attributes of the lane.
+   * This can include information such as the vehicle types for which the lane is designated.
+   *
+   * @return an object representing the access attributes of the lane.
+   */
+  @Nullable
+  @SerializedName("access")
+  public abstract IntersectionLaneAccess access();
+
   /**
    * Convert the current {@link IntersectionLanes} to its builder holding the currently assigned
    * values. This allows you to modify a single property and then rebuild the object resulting in
@@ -109,7 +119,11 @@ public static Builder builder() {
    * @since 3.0.0
    */
   public static TypeAdapter<IntersectionLanes> typeAdapter(Gson gson) {
-    return new IntersectionLanesTypeAdapter(new AutoValue_IntersectionLanes.GsonTypeAdapter(gson));
+    final Gson customGson = gson.newBuilder()
+      .registerTypeAdapter(String.class, new InterningStringAdapter())
+      .create();
+
+    return new AutoValue_IntersectionLanes.GsonTypeAdapter(customGson);
   }
 
   /**
@@ -176,14 +190,22 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Builde
      */
     public abstract Builder indications(@Nullable List<String> indications);
 
-    /*
+    /**
      * Set available payment methods for the lane.
      * @param paymentMethods is a list of strings where each value
-     *         matches {@link DirectionsCriteria.PaymentMethodsCriteria}
+     *         matches {@link PaymentMethodsCriteria}
      */
-    @SuppressWarnings("checkstyle:javadocmethod")
     public abstract Builder paymentMethods(@Nullable List<String> paymentMethods);
 
+    /**
+     * A {@link IntersectionLaneAccess} object representing the access attributes of the lane.
+     * This can include information such as the vehicle types for which the lane is designated.
+     *
+     * @param access an object representing the access attributes of the lane.
+     * @return this builder for chaining options together
+     */
+    public abstract Builder access(@Nullable IntersectionLaneAccess access);
+
     /**
      * Build a new {@link IntersectionLanes} object.
      *