Package com.uber.h3core

Enum Class AreaUnit

java.lang.Object

java.lang.Enum<AreaUnit>

com.uber.h3core.AreaUnit

All Implemented Interfaces:

Serializable, Comparable<AreaUnit>, Constable

public enum AreaUnit
extends Enum<AreaUnit>

Unit of measurement for areas.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
km2	Square kilometers
m2	Square meters
rads2	Square radians on the WGS84 sphere

Method Summary

Modifier and Type	Method	Description
static AreaUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AreaUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

rads2

public static final AreaUnit rads2

Square radians on the WGS84 sphere

km2

public static final AreaUnit km2

Square kilometers

m2

public static final AreaUnit m2

Square meters

Method Details

values

public static AreaUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AreaUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null