com.mapbox.mapboxsdk.style.functions.stops.Stop Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mapbox-android-sdk Show documentation
Mapbox GL Android SDK
There is a newer version: 9.2.1
package com.mapbox.mapboxsdk.style.functions.stops;

import com.mapbox.mapboxsdk.style.functions.Function;
import com.mapbox.mapboxsdk.style.layers.PropertyValue;

import java.util.HashMap;
import java.util.Map;

/**
 * A stop represents a certain point in the range of this function
 *
 * @param  input the stop (function) input type
 * @param  output the stop (function) output type
 * @see The style specification
 */
public class Stop {
  /**
   * Creates a {@link Stop} to use in a {@link Function}
   *
   * @param in     the input for the stop
   * @param output the output for the stop
   * @param     the input property type
   * @param     the output property type
   * @return the {@link Stop}
   */
  public static  Stop stop(I in, PropertyValue output) {
    return new Stop<>(in, output.value);
  }

  /**
   * Create a composite {@link Stop} for use in a {@link com.mapbox.mapboxsdk.style.functions.CompositeFunction}
   *
   * @param zoom   the zoom input
   * @param value  the feature property input
   * @param output the output for the stop
   * @param     the zoom type
   * @param     the feature property input type
   * @param     the output property type
   * @return the {@link Stop}
   * @see Function#composite(String, ExponentialStops)
   */
  public static  Stop, O> stop(Z zoom,
                                                                                 I value,
                                                                                 PropertyValue output) {
    return new Stop<>(new Stop.CompositeValue<>(zoom, value), output.value);
  }

  /**
   * Represents a composite input value for composite functions (eg zoom and feature property value)
   *
   * @param  the zoom input type (typically Float)
   * @param  the feature property input type
   */
  public static class CompositeValue {
    public final Z zoom;
    public final V value;

    CompositeValue(Z zoom, V value) {
      this.zoom = zoom;
      this.value = value;
    }

    /**
     * INTERNAL USAGE ONLY
     *
     * @return the value object representation for core conversion
     */
    Map toValueObject() {
      HashMap map = new HashMap<>();
      map.put("zoom", zoom);
      map.put("value", value);
      return map;
    }

    @Override
    public String toString() {
      return String.format("[zoom: %s, value: %s]", zoom, value);
    }
  }

  /**
   * The input type
   */
  public final I in;

  /**
   * The output type
   */
  public final O out;

  Stop(I in, O out) {
    this.in = in;
    this.out = out;
  }

  /**
   * INTERNAL USAGE ONLY
   *
   * @return an array representation of the Stop
   */
  Object[] toValueObject() {
    return new Object[] {in instanceof CompositeValue ? ((CompositeValue) in).toValueObject() : in, out};
  }

  @Override
  public String toString() {
    return String.format("[%s, %s]", in, out);
  }
}