Package com.azure.core.models

Class GeoPolygon

java.lang.Object

com.azure.core.models.GeoObject

com.azure.core.models.GeoPolygon

public final class GeoPolygon
extends GeoObject

Represents a geometric polygon.

Constructor Summary

Constructors

Constructor	Description
GeoPolygon(GeoLinearRing ring)	Constructs a geometric polygon.
GeoPolygon(GeoLinearRing ring, GeoBoundingBox boundingBox, Map<String,Object> customProperties)	Constructs a geometric polygon.
GeoPolygon(List<GeoLinearRing> rings)	Constructs a geometric polygon.
GeoPolygon(List<GeoLinearRing> rings, GeoBoundingBox boundingBox, Map<String,Object> customProperties)	Constructs a geometric polygon.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
GeoLinearRing	getOuterRing()	Gets the outer ring of the polygon.
List<GeoLinearRing>	getRings()	Unmodifiable representation of the geometric rings representing this polygon.
GeoObjectType	getType()	Gets the GeoJSON type for this object.
int	hashCode()

Methods inherited from class com.azure.core.models.GeoObject

getBoundingBox, getCustomProperties

Methods inherited from class java.lang.Object

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

Constructor Details

GeoPolygon

public GeoPolygon(GeoLinearRing ring)

Constructs a geometric polygon.

Parameters:

ring - The ring that defines the polygon.

Throws:

NullPointerException - If ring is null.

GeoPolygon

public GeoPolygon(GeoLinearRing ring,
 GeoBoundingBox boundingBox,
 Map<String,Object> customProperties)

Constructs a geometric polygon.

Parameters:

ring - The ring that defines the polygon.

boundingBox - Bounding box for the polygon.

customProperties - Additional properties of the polygon.

Throws:

NullPointerException - If ring is null.

GeoPolygon

public GeoPolygon(List<GeoLinearRing> rings)

Constructs a geometric polygon.

Parameters:

rings - The rings that define the polygon.

Throws:

NullPointerException - If rings is null.

GeoPolygon

public GeoPolygon(List<GeoLinearRing> rings,
 GeoBoundingBox boundingBox,
 Map<String,Object> customProperties)

Constructs a geometric polygon.

Parameters:

rings - The rings that define the polygon.

boundingBox - Bounding box for the polygon.

customProperties - Additional properties of the polygon.

Throws:

NullPointerException - If rings is null.

Method Details

getRings

public List<GeoLinearRing> getRings()

Unmodifiable representation of the geometric rings representing this polygon.

Returns:

An unmodifiable representation of the geometric rings representing this polygon.

getOuterRing

public GeoLinearRing getOuterRing()

Gets the outer ring of the polygon.

Returns:

Outer ring of the polygon.

getType

public GeoObjectType getType()

Description copied from class: GeoObject

Gets the GeoJSON type for this object.

Specified by:

getType in class GeoObject

Returns:

The GeoJSON type for this object.

hashCode

public int hashCode()

Overrides:

hashCode in class GeoObject

equals

public boolean equals(Object obj)

Overrides:

equals in class GeoObject