Package org.opensearch.common.geo
Enum GeoDistance
java.lang.Object
java.lang.Enum<GeoDistance>
org.opensearch.common.geo.GeoDistance
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<GeoDistance>
,java.lang.constant.Constable
,Writeable
public enum GeoDistance extends java.lang.Enum<GeoDistance> implements Writeable
Geo distance calculation.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Enum Constant Summary
-
Method Summary
Modifier and Type Method Description double
calculate(double srcLat, double srcLon, double dstLat, double dstLon, DistanceUnit unit)
compute the distance between two points using the selected algorithm (PLANE, ARC)static GeoDistance
fromString(java.lang.String name)
Get aGeoDistance
according to a given name.static GeoDistance
readFromStream(StreamInput in)
Creates a GeoDistance instance from an input streamstatic GeoDistance
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static GeoDistance[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.void
writeTo(StreamOutput out)
Writes an instance of a GeoDistance object to an output stream
-
Enum Constant Details
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
readFromStream
Creates a GeoDistance instance from an input stream- Throws:
java.io.IOException
-
writeTo
Writes an instance of a GeoDistance object to an output stream -
fromString
Get aGeoDistance
according to a given name. Valid values are- plane for
GeoDistance.PLANE
- arc for
GeoDistance.ARC
- Parameters:
name
- name of theGeoDistance
- Returns:
- a
GeoDistance
- plane for
-
calculate
public double calculate(double srcLat, double srcLon, double dstLat, double dstLon, DistanceUnit unit)compute the distance between two points using the selected algorithm (PLANE, ARC)
-