com.google.maps.clients.mapsengine.geojson

Class Polygon

java.lang.Object

com.google.maps.clients.mapsengine.geojson.Geometry

com.google.maps.clients.mapsengine.geojson.Polygon

public class Polygon
extends Geometry

A 3 or more sided shape with straight sides.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.util.List<Point>>	points

Fields inherited from class com.google.maps.clients.mapsengine.geojson.Geometry

FEATURE_TYPE

Constructor Summary

Constructors

Constructor and Description
Polygon(com.google.api.services.mapsengine.model.Feature feature) Converts the provided Feature into a typed Polygon, discarding properties.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.services.mapsengine.model.Feature	asFeature(java.util.Map<java.lang.String,java.lang.Object> properties) Returns a Feature that can be used by the Maps Engine API.
static Polygon	createMultiRingPolygon(java.util.List<java.util.List<Point>> points) Creates a multi-ring polygon using the list of points provided.
static Polygon	createSimplePolygon(java.util.List<Point> points) Creates a polygon using the list of points provided.
java.util.List<java.util.List<Point>>	getPoints() Get the list of points that make up this polygon.

Methods inherited from class com.google.maps.clients.mapsengine.geojson.Geometry

fromGeoJson

Methods inherited from class java.lang.Object

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

Field Detail

points

protected java.util.List<java.util.List<Point>> points

Constructor Detail

Polygon

public Polygon(com.google.api.services.mapsengine.model.Feature feature)

Converts the provided Feature into a typed Polygon, discarding properties. Throws an exception if the feature is not a polygon.

Parameters:

feature - the Feature returned by the API

Throws:

java.lang.IllegalArgumentException - when feature is not a polygon

Method Detail

createSimplePolygon

public static Polygon createSimplePolygon(java.util.List<Point> points)

Creates a polygon using the list of points provided. The first and last points must be the same in order to close the polygon, there must be four or more points and they must be in counter-clockwise order. No checking is done in this client, any errors will be returned by the server-side API.

Parameters:

points - A list of 4 or more points, in counter-clockwise order

createMultiRingPolygon

public static Polygon createMultiRingPolygon(java.util.List<java.util.List<Point>> points)

Creates a multi-ring polygon using the list of points provided. The first outer list represents the outer ring of the polygon and each successive outer list represents inner rings, or holes, in the polygon. The first and last points of each ring must be the same in order to close the ring, there must be four or more points and they must be in counter-clockwise order. No checking is done in this client, any errors will be returned by the server-side API.

Parameters:

points - A list of 1 or more linear rings (lists of points)

asFeature

public com.google.api.services.mapsengine.model.Feature asFeature(java.util.Map<java.lang.String,java.lang.Object> properties)

Returns a Feature that can be used by the Maps Engine API.

Specified by:

asFeature in class Geometry

Parameters:

properties - The properties to attach to the feature

Returns:

an API-compatible Feature object

getPoints

public java.util.List<java.util.List<Point>> getPoints()

Get the list of points that make up this polygon. If only a single ring was used to create this Polygon, the resulting outer list will contain exactly one element.

Returns:

A list of 1 or more linear rings (lists of points) representing this polygon