com.mapbox.mapboxsdk.style.functions

Class CompositeFunction<Z extends java.lang.Number,I,O>

java.lang.Object

com.mapbox.mapboxsdk.style.functions.Function<Stop.CompositeValue<Z,I>,O>

com.mapbox.mapboxsdk.style.functions.CompositeFunction<Z,I,O>

Type Parameters:

Z - the zoom type (usually Float)

I - the input type (the feature property type)

O - the output type (the property type)

public class CompositeFunction<Z extends java.lang.Number,I,O>
extends Function<Stop.CompositeValue<Z,I>,O>

Composite functions combine Camera and SourceFunctions.

Composite functions allow the appearance of a map feature to change with both its properties and zoom. Each stop is an array with two elements, the first is an object with a property input value and a zoom, and the second is a function output value. Note that support for property functions is not yet complete.

See Also:

Function.composite(java.lang.String, com.mapbox.mapboxsdk.style.functions.stops.CategoricalStops<com.mapbox.mapboxsdk.style.functions.stops.Stop.CompositeValue<Z, I>, O>)

Method Summary

Modifier and Type	Method and Description
PropertyValue<O>	getDefaultValue()
java.lang.String	getProperty() INTERNAL USAGE ONLY
java.util.Map<java.lang.String,java.lang.Object>	toValueObject() INTERNAL USAGE ONLY
CompositeFunction<Z,I,O>	withDefaultValue(PropertyValue<O> defaultValue) Set the default value

Methods inherited from class com.mapbox.mapboxsdk.style.functions.Function

composite, composite, composite, getStops, getStopsAs, property, property, property, property, toString, zoom, zoom

Methods inherited from class java.lang.Object

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

Method Detail

withDefaultValue

public CompositeFunction<Z,I,O> withDefaultValue(PropertyValue<O> defaultValue)

Set the default value

Parameters:

defaultValue - the default value to use when no other applies

Returns:

this (for chaining)

getDefaultValue

@Nullable
public PropertyValue<O> getDefaultValue()

Returns:

the defaultValue

getProperty

public java.lang.String getProperty()

INTERNAL USAGE ONLY

Returns:

the feature property name

toValueObject

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

INTERNAL USAGE ONLY

Overrides:

toValueObject in class Function<Stop.CompositeValue<Z extends java.lang.Number,I>,O>

Returns:

a value object representation for core conversion