com.uber.h3core

Enum AreaUnit

java.lang.Object

java.lang.Enum<AreaUnit>

com.uber.h3core.AreaUnit

All Implemented Interfaces:

Serializable, Comparable<AreaUnit>

public enum AreaUnit
extends Enum<AreaUnit>

Unit of measurement for areas.

Enum Constant Summary

Enum Constants

Enum Constant and Description
km2 Square kilometers
m2 Square meters

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

km2

public static final AreaUnit km2

Square kilometers

m2

public static final AreaUnit m2

Square meters

Method Detail

values

public static AreaUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AreaUnit c : AreaUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static AreaUnit valueOf(String name)

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:

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

NullPointerException - if the argument is null