AreaUnit (GRA 3.0.1 API)

java.lang.Object
- java.lang.Enum<AreaUnit>
- - com.mapinfo.midev.unit.AreaUnit

All Implemented Interfaces:

Serializable, Comparable<AreaUnit>
```
public enum AreaUnit
extends Enum<AreaUnit>
```
A unit of measure for area.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACRE` An AreaUnit representing acres (4840 sq yards).
`ARE` An AreaUnit representing ares (100 sq meters).
`HECTARE` An AreaUnit representing hectares (10000 sq meters).
`PERCH` An AreaUnit representing perches (30.25 sq yards).
`ROOD` An AreaUnit representing roods (1/4 acres or 1210 sq yards).
`SQUARE_CENTIMETER` An AreaUnit representing square centimeters.
`SQUARE_CHAIN` An AreaUnit representing square chains.
`SQUARE_FOOT` An AreaUnit representing square feet.
`SQUARE_INCH` An AreaUnit representing square inches.
`SQUARE_KILOMETER` An AreaUnit representing square kilometers.
`SQUARE_LINK` An AreaUnit representing square links.
`SQUARE_METER` An AreaUnit representing square meters.
`SQUARE_MILE` An AreaUnit representing square miles.
`SQUARE_MILLIMETER` An AreaUnit representing square millimeters.
`SQUARE_NAUTICAL_MILE` An AreaUnit representing square nautical miles.
`SQUARE_ROD` An AreaUnit representing square rods.
`SQUARE_SURVEY_FOOT` An AreaUnit representing square US survey feet.
`SQUARE_YARD` An AreaUnit representing square yards.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`convert(double area, AreaUnit fromUnit, AreaUnit toUnit)` Convert the specified area to its equivalent value in another area unit.
`double`	`getSquareMetersPerUnit()` Get the number of square meters equivalent to one of this unit of measure.
`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
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SQUARE_INCH
```
public static final AreaUnit SQUARE_INCH
```
    An AreaUnit representing square inches.
  - SQUARE_FOOT
```
public static final AreaUnit SQUARE_FOOT
```
    An AreaUnit representing square feet.
  - SQUARE_YARD
```
public static final AreaUnit SQUARE_YARD
```
    An AreaUnit representing square yards.
  - SQUARE_MILE
```
public static final AreaUnit SQUARE_MILE
```
    An AreaUnit representing square miles.
  - SQUARE_MILLIMETER
```
public static final AreaUnit SQUARE_MILLIMETER
```
    An AreaUnit representing square millimeters.
  - SQUARE_CENTIMETER
```
public static final AreaUnit SQUARE_CENTIMETER
```
    An AreaUnit representing square centimeters.
  - SQUARE_METER
```
public static final AreaUnit SQUARE_METER
```
    An AreaUnit representing square meters.
  - SQUARE_KILOMETER
```
public static final AreaUnit SQUARE_KILOMETER
```
    An AreaUnit representing square kilometers.
  - SQUARE_SURVEY_FOOT
```
public static final AreaUnit SQUARE_SURVEY_FOOT
```
    An AreaUnit representing square US survey feet.
  - SQUARE_NAUTICAL_MILE
```
public static final AreaUnit SQUARE_NAUTICAL_MILE
```
    An AreaUnit representing square nautical miles.
  - SQUARE_LINK
```
public static final AreaUnit SQUARE_LINK
```
    An AreaUnit representing square links.
  - SQUARE_CHAIN
```
public static final AreaUnit SQUARE_CHAIN
```
    An AreaUnit representing square chains.
  - SQUARE_ROD
```
public static final AreaUnit SQUARE_ROD
```
    An AreaUnit representing square rods.
  - ACRE
```
public static final AreaUnit ACRE
```
    An AreaUnit representing acres (4840 sq yards).
  - ARE
```
public static final AreaUnit ARE
```
    An AreaUnit representing ares (100 sq meters).
  - HECTARE
```
public static final AreaUnit HECTARE
```
    An AreaUnit representing hectares (10000 sq meters).
  - PERCH
```
public static final AreaUnit PERCH
```
    An AreaUnit representing perches (30.25 sq yards).
  - ROOD
```
public static final AreaUnit ROOD
```
    An AreaUnit representing roods (1/4 acres or 1210 sq yards).
- 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
  - getSquareMetersPerUnit
```
public double getSquareMetersPerUnit()
```
    Get the number of square meters equivalent to one of this unit of measure.
    
    Returns:
    
    The number of square meters equivalent to one of this unit of measure.
  - convert
```
public static double convert(double area,
                             AreaUnit fromUnit,
                             AreaUnit toUnit)
```
    Convert the specified area to its equivalent value in another area unit.
    
    Parameters:
    
    area - An area with unit fromUnit
    
    fromUnit - The area unit of the specified area.
    
    toUnit - The area unit for the converted value.
    
    Returns:
    
    The converted area in the specified units.

Enum AreaUnit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SQUARE_INCH

SQUARE_FOOT

SQUARE_YARD

SQUARE_MILE

SQUARE_MILLIMETER

SQUARE_CENTIMETER

SQUARE_METER

SQUARE_KILOMETER

SQUARE_SURVEY_FOOT

SQUARE_NAUTICAL_MILE

SQUARE_LINK

SQUARE_CHAIN

SQUARE_ROD

ACRE

ARE

HECTARE

PERCH

ROOD

Method Detail

values

valueOf

getSquareMetersPerUnit

convert