com.mongodb.client.model.geojson

Class Polygon

java.lang.Object

com.mongodb.client.model.geojson.Geometry

com.mongodb.client.model.geojson.Polygon

public final class Polygon
extends Geometry

A representation of a GeoJSON Polygon.

Since:

3.1

Constructor Summary

Constructors

Constructor and Description
Polygon(CoordinateReferenceSystem coordinateReferenceSystem, PolygonCoordinates coordinates) Construct an instance with the given coordinates and coordinate reference system.
Polygon(List<Position> exterior, List<Position>... holes) Construct an instance with the given coordinates.
Polygon(PolygonCoordinates coordinates) Construct an instance with the given coordinates.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
PolygonCoordinates	getCoordinates() Gets the GeoJSON coordinates of the polygon
List<Position>	getExterior() Gets the exterior coordinates.
List<List<Position>>	getHoles() Get the holes in this polygon.
GeoJsonObjectType	getType() Gets the GeoJSON object type.
int	hashCode()
String	toString()

Methods inherited from class com.mongodb.client.model.geojson.Geometry

getCoordinateReferenceSystem, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Polygon

public Polygon(List<Position> exterior,
               List<Position>... holes)

Construct an instance with the given coordinates.

Parameters:

exterior - the exterior ring of the polygon

holes - optional interior rings of the polygon

Polygon

public Polygon(PolygonCoordinates coordinates)

Construct an instance with the given coordinates.

Parameters:

coordinates - the coordinates

Polygon

public Polygon(CoordinateReferenceSystem coordinateReferenceSystem,
               PolygonCoordinates coordinates)

Construct an instance with the given coordinates and coordinate reference system.

Parameters:

coordinateReferenceSystem - the coordinate reference system

coordinates - the coordinates

Method Detail

getType

public GeoJsonObjectType getType()

Description copied from class: Geometry

Gets the GeoJSON object type.

Specified by:

getType in class Geometry

Returns:

the type

getCoordinates

public PolygonCoordinates getCoordinates()

Gets the GeoJSON coordinates of the polygon

Returns:

the coordinates, which must have at least one element

getExterior

public List<Position> getExterior()

Gets the exterior coordinates.

Returns:

the exterior coordinates

getHoles

public List<List<Position>> getHoles()

Get the holes in this polygon.

Returns:

the possibly-empty list of holes

equals

public boolean equals(Object o)

Overrides:

equals in class Geometry

hashCode

public int hashCode()

Overrides:

hashCode in class Geometry

toString

public String toString()

Overrides:

toString in class Object