com.mapbox.services.api.utils.turf

Class TurfInvariant

java.lang.Object

com.mapbox.services.api.utils.turf.TurfInvariant

public class TurfInvariant
extends java.lang.Object

Also called Assertions, these methods enforce expectations of a certain type or calculate various shapes from given points.

Since:

1.2.0

See Also:

Turf documentation

Constructor Summary

Constructors

Constructor and Description
TurfInvariant()

Method Summary

Modifier and Type	Method and Description
static void	collectionOf(com.mapbox.services.commons.geojson.FeatureCollection featurecollection, java.lang.String type, java.lang.String name) Enforce expectations about types of FeatureCollection inputs for Turf.
static void	featureOf(com.mapbox.services.commons.geojson.Feature feature, java.lang.String type, java.lang.String name) Enforce expectations about types of Feature inputs for Turf.
static void	geojsonType(com.mapbox.services.commons.geojson.GeoJSON value, java.lang.String type, java.lang.String name) Enforce expectations about types of GeoJSON objects for Turf.
static com.mapbox.services.commons.models.Position	getCoord(com.mapbox.services.commons.geojson.Feature obj) Unwrap a coordinate from a Feature with a Point geometry, a Point geometry, or a single coordinate.
static com.mapbox.services.commons.models.Position	getCoord(com.mapbox.services.commons.geojson.Point obj)

Methods inherited from class java.lang.Object

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

Constructor Detail

TurfInvariant

public TurfInvariant()

Method Detail

getCoord

public static com.mapbox.services.commons.models.Position getCoord(com.mapbox.services.commons.geojson.Feature obj)
                                                            throws TurfException

Unwrap a coordinate from a Feature with a Point geometry, a Point geometry, or a single coordinate.

Parameters:

obj - any value

Returns:

A coordinate

Throws:

TurfException - Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf getCoord documentation

getCoord

public static com.mapbox.services.commons.models.Position getCoord(com.mapbox.services.commons.geojson.Point obj)
                                                            throws TurfException

Throws:

TurfException

geojsonType

public static void geojsonType(com.mapbox.services.commons.geojson.GeoJSON value,
                               java.lang.String type,
                               java.lang.String name)
                        throws TurfException

Enforce expectations about types of GeoJSON objects for Turf.

Parameters:

value - Any GeoJSON object.

type - Type expected GeoJSON type.

name - Name of calling function.

Throws:

TurfException - Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf geojsonType documentation

featureOf

public static void featureOf(com.mapbox.services.commons.geojson.Feature feature,
                             java.lang.String type,
                             java.lang.String name)
                      throws TurfException

Enforce expectations about types of Feature inputs for Turf. Internally this uses Feature.getType() to judge geometry types.

Parameters:

feature - A feature with an expected geometry type.

type - Type expected GeoJSON type.

name - Name of calling function.

Throws:

TurfException - Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf featureOf documentation

collectionOf

public static void collectionOf(com.mapbox.services.commons.geojson.FeatureCollection featurecollection,
                                java.lang.String type,
                                java.lang.String name)
                         throws TurfException

Enforce expectations about types of FeatureCollection inputs for Turf. Internally this uses Feature.getType()} to judge geometry types.

Parameters:

featurecollection - A FeatureCollection for which features will be judged

type - Expected GeoJSON type.

name - Name of calling function.

Throws:

TurfException - Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf collectionOf documentation