com.mapbox.mapboxsdk.style.functions.stops

Class ExponentialStops<I,O>

java.lang.Object

com.mapbox.mapboxsdk.style.functions.stops.Stops<I,O>

com.mapbox.mapboxsdk.style.functions.stops.IterableStops<I,O,Stop<I,O>>

com.mapbox.mapboxsdk.style.functions.stops.ExponentialStops<I,O>

Type Parameters:

I - the input type

O - the output type

All Implemented Interfaces:

java.lang.Iterable<Stop<I,O>>

public class ExponentialStops<I,O>
extends IterableStops<I,O,Stop<I,O>>

The Stops implementation for exponential functions

Constructor Summary

Constructors

Constructor and Description
ExponentialStops(java.lang.Float base, Stop<I,O>... stops) Create exponential stops with an explicit base.
ExponentialStops(Stop<I,O>... stops) Create exponential stops without an explicit base.

Method Summary

Modifier and Type	Method and Description
float	getBase()
java.lang.String	getTypeName() INTERNAL USAGE ONLY
java.util.Iterator<Stop<I,O>>	iterator()
int	size()
java.util.Map<java.lang.String,java.lang.Object>	toValueObject() INTERNAL USAGE ONLY
ExponentialStops<I,O>	withBase(float base) Set the exponential base

Methods inherited from class com.mapbox.mapboxsdk.style.functions.stops.IterableStops

toString

Methods inherited from class com.mapbox.mapboxsdk.style.functions.stops.Stops

categorical, exponential, identity, interval

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ExponentialStops

@SafeVarargs
public ExponentialStops(java.lang.Float base,
                                     @NonNull
                                     Stop<I,O>... stops)

Create exponential stops with an explicit base. Use through Stops.exponential(Stop[])

Parameters:

base - The exponential base of the interpolation curve. It controls the rate at which the function output increases. Higher values make the output increase more towards the high end of the range. With values close to 1 the output increases linearly.

stops - the stops

ExponentialStops

@SafeVarargs
public ExponentialStops(@NonNull
                                     Stop<I,O>... stops)

Create exponential stops without an explicit base. Use through Stops.exponential(Stop[])

Parameters:

stops - the stops

Method Detail

withBase

public ExponentialStops<I,O> withBase(float base)

Set the exponential base

Parameters:

base - the base to use in the exponential function

Returns:

this (for chaining)

getBase

public float getBase()

Returns:

The exponential base

toValueObject

public java.util.Map<java.lang.String,java.lang.Object> toValueObject()

INTERNAL USAGE ONLY

Overrides:

toValueObject in class Stops<I,O>

Returns:

the value object representation for conversion to core

getTypeName

public java.lang.String getTypeName()

INTERNAL USAGE ONLY

Specified by:

getTypeName in class Stops<I,O>

Returns:

the unique type name as a string according to the style specification

iterator

public java.util.Iterator<Stop<I,O>> iterator()

size

public int size()

Specified by:

size in class IterableStops<I,O,Stop<I,O>>

Returns:

The size of the contained stops collection