Units (SWC - Sweble Engine 3.1.9 API)

java.lang.Object
- java.lang.Enum<Units>
- - org.sweble.wikitext.engine.ext.convert.Units

All Implemented Interfaces:

Serializable, Comparable<Units>
```
public enum Units
extends Enum<Units>
```
The following SI Units are used as scale base for conversions.
```
 length               metre       m
 mass                 kilogram    kg
 time                 second      s
 electric current     ampere      A
 temperature          kelvin      K
 amount of substance  mole        mol
 luminous intensity   candela     cd
 
```
The complete and actual data set used from the original template (Lua) can be found here: https://en.wikipedia.org/wiki/Module:Convert/data The following HTML chars where substituted with the corresponding Unicode chars: ' ' ' ' ‑ 舉 '‑'

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACRE`
`AMPERE_HOUR`
`ANGSTROM`
`ARE`
`ARPENT`
`ASTRONOMICAL_UNIT`
`BANANA`
`BARREL_OF_OIL_EQUIVALENT`
`BARREL_OF_OIL_EQUIVALENT2`
`BOARD_OF_TRADE_UNIT`
`BTU`
`BTU_39F`
`BTU_59F`
`BTU_60F`
`BTU_63F`
`BTU_ISO`
`BTU_IT`
`BTU_MEAN`
`BTU_TH`
`CAL_15C`
`CAL_15C2`
`CAL_IT`
`CAL_IT2`
`CAL_TH`
`CAL_TH2`
`CALORIE`
`CALORIE2`
`CARAT`
`CCATM`
`CENT`
`CENTIMETRE`
`CENTIMETRE_PER_SEC_SQ`
`CHAIN`
`COULOMB`
`CUERDA`
`DAA`
`DECAMETRE`
`DECIGRAM`
`DECIMETRE`
`DEGREE_CELSIUS`
`DEGREE_FAHRENHEIT`
`DEGREE_RANKINE`
`DRACHM`
`DUNAM`
`DUNUM`
`E`
`FATHOM`
`FOOT`
`FOOT_PER_SEC_SQ`
`FURLONG`
`GIGAJOULE`
`GIGALIGHT_YEAR`
`GIGAMETRE`
`GIGAPARSEC`
`GRAIN`
`GRAM`
`GRAM_MOLE`
`GRAM_MOLE2`
`GRAM_PER_LITRE`
`GRAM_PER_ML`
`GRAMM_PER_CUBIC_DM`
`GRAY`
`HAND`
`HECTARE`
`HECTOMETRE`
`INCH`
`IRISH_ACRE`
`JOULE`
`KELVIN`
`KILOCALORIE`
`KILOELECTRONVOLT`
`KILOGRAM`
`KILOGRAM_PER_DM3`
`KILOGRAM_PER_LITRE`
`KILOGRAMM_PER_CUBIC_M`
`KILOGRAMM_PER_LITRE`
`KILOJOULE`
`KILOLIGHT_YEAR`
`KILOMETRE`
`KILOMETRE_PER_H_PER_SEC`
`KILOMETRE_PER_SEC_SQ`
`KILOMOLE`
`KILOPARSEC`
`LIGHT_YEAR`
`LONG_HUNDREDWEIGHT`
`LONG_QUARTER`
`LONG_TON`
`M2_PER_HA`
`MEAGAMETRE`
`MEGAJOULE`
`MEGALIGHT_YEAR`
`MEGAPARSEC`
`METRE`
`METRE_PER_SEC_SQ`
`METRIC_TON`
`MICORINCH`
`MICROGRAM`
`MICROMETRE`
`MILE`
`MILE_PER_H_PER_SEC`
`MILLIGRAM`
`MILLIGRAM_PER_LITRE`
`MILLIJOULE`
`MILLIMETRE`
`MOLE`
`NANOMETRE`
`NAUTICAL_MILE`
`NAUTICAL_MILE_OLD_BRIT`
`NAUTICAL_MILE_OLD_US`
`OUNCE`
`OUNCE_PER_CUBIC_IN`
`PARSEC`
`PENNYWEIGHT`
`PERCH`
`POLE`
`PONDEMAAT`
`POUND`
`POUND_MASS_PER_CUBIC_IN`
`POUND_MOLE`
`POUND_MOLE2`
`POUND_PER_CUBIC_FT`
`POUND_PER_CUBIC_IN`
`POUND_PER_CUBIC_IN2`
`POUND_PER_CUBIC_YD`
`POUND_PER_IMP_GAL`
`POUND_PER_US_BUSHEL`
`POUND_PER_US_GAL`
`POUND_PER_US_GAL2`
`POUNT_PER_US_GAL`
`PYEONG`
`RAD`
`RAI`
`ROD`
`ROOD`
`SHORT_HUNDREDWEIGHT`
`SHORT_QUARTER`
`SHORT_TON`
`SQFT_PER_ACRE`
`SQUARE_CENTIMETRE`
`SQUARE_DECAMETRE`
`SQUARE_DECIMETRE`
`SQUARE_FOOT`
`SQUARE_FOOT2`
`SQUARE_HECTOMETRE`
`SQUARE_INCH`
`SQUARE_KILOMETRE`
`SQUARE_METRE`
`SQUARE_MILE`
`SQUARE_MILLIMETRE`
`SQUARE_NAUTICAL_MILE`
`SQUARE_PERCH`
`SQUARE_VERST`
`SQUARE_YARD`
`STANDARD_GRAVITY`
`STONE`
`THOUSAND_SQFT`
`TONNE`
`TROY_OUNCE`
`TROY_POUND`
`TSUBO`
`YHARD`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`getAltCodes()`
`DefCvt`	`getDefaultCvt()`
`String`	`getName()`
`double`	`getOffset()`
`String`	`getPluralName()` Gets the plural form of the Unit (e.g.
`double`	`getScale()`
`String`	`getSymbol()`
`String`	`getUsName()` Gets the U.S.
`static boolean`	`isSameUnitType(Units a, Units b)` Checks if two units are from the same type (e.g.
`static Units`	`searchUnitFromName(String name)` Searches the Unit according to the given name.
`static Units`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Units[]`	`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

GRAY
```
public static final Units GRAY
```

RAD
```
public static final Units RAD
```

CENTIMETRE_PER_SEC_SQ

public static final Units CENTIMETRE_PER_SEC_SQ

FOOT_PER_SEC_SQ

public static final Units FOOT_PER_SEC_SQ

STANDARD_GRAVITY

public static final Units STANDARD_GRAVITY

KILOMETRE_PER_H_PER_SEC

public static final Units KILOMETRE_PER_H_PER_SEC

KILOMETRE_PER_SEC_SQ

public static final Units KILOMETRE_PER_SEC_SQ

METRE_PER_SEC_SQ

public static final Units METRE_PER_SEC_SQ

MILE_PER_H_PER_SEC

public static final Units MILE_PER_H_PER_SEC

SQUARE_KILOMETRE

public static final Units SQUARE_KILOMETRE

SQUARE_HECTOMETRE

public static final Units SQUARE_HECTOMETRE

SQUARE_DECAMETRE

public static final Units SQUARE_DECAMETRE

SQUARE_METRE
```
public static final Units SQUARE_METRE
```

SQUARE_DECIMETRE

public static final Units SQUARE_DECIMETRE

SQUARE_CENTIMETRE

public static final Units SQUARE_CENTIMETRE

SQUARE_MILLIMETRE

public static final Units SQUARE_MILLIMETRE

THOUSAND_SQFT

public static final Units THOUSAND_SQFT

ARE
```
public static final Units ARE
```

ACRE
```
public static final Units ACRE
```

ARPENT
```
public static final Units ARPENT
```

CUERDA
```
public static final Units CUERDA
```

DAA
```
public static final Units DAA
```

DUNAM
```
public static final Units DUNAM
```

DUNUM
```
public static final Units DUNUM
```

HECTARE
```
public static final Units HECTARE
```

IRISH_ACRE
```
public static final Units IRISH_ACRE
```

PONDEMAAT
```
public static final Units PONDEMAAT
```

PYEONG
```
public static final Units PYEONG
```

RAI
```
public static final Units RAI
```

ROOD
```
public static final Units ROOD
```

SQUARE_FOOT
```
public static final Units SQUARE_FOOT
```

SQUARE_FOOT2
```
public static final Units SQUARE_FOOT2
```

SQUARE_INCH
```
public static final Units SQUARE_INCH
```

SQUARE_NAUTICAL_MILE

public static final Units SQUARE_NAUTICAL_MILE

SQUARE_MILE
```
public static final Units SQUARE_MILE
```

SQUARE_PERCH
```
public static final Units SQUARE_PERCH
```

SQUARE_VERST
```
public static final Units SQUARE_VERST
```

SQUARE_YARD
```
public static final Units SQUARE_YARD
```

TSUBO
```
public static final Units TSUBO
```

M2_PER_HA
```
public static final Units M2_PER_HA
```

SQFT_PER_ACRE

public static final Units SQFT_PER_ACRE

CENT
```
public static final Units CENT
```

AMPERE_HOUR
```
public static final Units AMPERE_HOUR
```

COULOMB
```
public static final Units COULOMB
```

E
```
public static final Units E
```

GRAM_MOLE
```
public static final Units GRAM_MOLE
```

GRAM_MOLE2
```
public static final Units GRAM_MOLE2
```

KILOMOLE
```
public static final Units KILOMOLE
```

POUND_MOLE
```
public static final Units POUND_MOLE
```

POUND_MOLE2
```
public static final Units POUND_MOLE2
```

MOLE
```
public static final Units MOLE
```

KILOGRAM_PER_LITRE

public static final Units KILOGRAM_PER_LITRE

POUNT_PER_US_GAL

public static final Units POUNT_PER_US_GAL

GRAMM_PER_CUBIC_DM

public static final Units GRAMM_PER_CUBIC_DM

GRAM_PER_LITRE

public static final Units GRAM_PER_LITRE

GRAM_PER_ML
```
public static final Units GRAM_PER_ML
```

KILOGRAM_PER_DM3

public static final Units KILOGRAM_PER_DM3

KILOGRAMM_PER_LITRE

public static final Units KILOGRAMM_PER_LITRE

KILOGRAMM_PER_CUBIC_M

public static final Units KILOGRAMM_PER_CUBIC_M

POUND_PER_CUBIC_FT

public static final Units POUND_PER_CUBIC_FT

POUND_PER_CUBIC_IN

public static final Units POUND_PER_CUBIC_IN

POUND_PER_CUBIC_IN2

public static final Units POUND_PER_CUBIC_IN2

POUND_PER_CUBIC_YD

public static final Units POUND_PER_CUBIC_YD

POUND_PER_IMP_GAL

public static final Units POUND_PER_IMP_GAL

POUND_PER_US_GAL

public static final Units POUND_PER_US_GAL

POUND_PER_US_GAL2

public static final Units POUND_PER_US_GAL2

POUND_PER_US_BUSHEL

public static final Units POUND_PER_US_BUSHEL

POUND_MASS_PER_CUBIC_IN

public static final Units POUND_MASS_PER_CUBIC_IN

MILLIGRAM_PER_LITRE

public static final Units MILLIGRAM_PER_LITRE

OUNCE_PER_CUBIC_IN

public static final Units OUNCE_PER_CUBIC_IN

BOARD_OF_TRADE_UNIT

public static final Units BOARD_OF_TRADE_UNIT

BARREL_OF_OIL_EQUIVALENT

public static final Units BARREL_OF_OIL_EQUIVALENT

BARREL_OF_OIL_EQUIVALENT2

public static final Units BARREL_OF_OIL_EQUIVALENT2

BTU
```
public static final Units BTU
```

BTU_39F
```
public static final Units BTU_39F
```

BTU_59F
```
public static final Units BTU_59F
```

BTU_60F
```
public static final Units BTU_60F
```

BTU_63F
```
public static final Units BTU_63F
```

BTU_ISO
```
public static final Units BTU_ISO
```

BTU_IT
```
public static final Units BTU_IT
```

BTU_MEAN
```
public static final Units BTU_MEAN
```

BTU_TH
```
public static final Units BTU_TH
```

CALORIE
```
public static final Units CALORIE
```

CALORIE2
```
public static final Units CALORIE2
```

CAL_15C
```
public static final Units CAL_15C
```

CAL_15C2
```
public static final Units CAL_15C2
```

CAL_IT
```
public static final Units CAL_IT
```

CAL_IT2
```
public static final Units CAL_IT2
```

CAL_TH
```
public static final Units CAL_TH
```

CAL_TH2
```
public static final Units CAL_TH2
```

CCATM
```
public static final Units CCATM
```

KILOCALORIE
```
public static final Units KILOCALORIE
```

GIGAJOULE
```
public static final Units GIGAJOULE
```

MEGAJOULE
```
public static final Units MEGAJOULE
```

KILOJOULE
```
public static final Units KILOJOULE
```

JOULE
```
public static final Units JOULE
```

MILLIJOULE
```
public static final Units MILLIJOULE
```

GIGAMETRE
```
public static final Units GIGAMETRE
```

MEAGAMETRE
```
public static final Units MEAGAMETRE
```

KILOMETRE
```
public static final Units KILOMETRE
```

HECTOMETRE
```
public static final Units HECTOMETRE
```

DECAMETRE
```
public static final Units DECAMETRE
```

METRE
```
public static final Units METRE
```

DECIMETRE
```
public static final Units DECIMETRE
```

CENTIMETRE
```
public static final Units CENTIMETRE
```

MILLIMETRE
```
public static final Units MILLIMETRE
```

MICROMETRE
```
public static final Units MICROMETRE
```

NANOMETRE
```
public static final Units NANOMETRE
```

ANGSTROM
```
public static final Units ANGSTROM
```

MILE
```
public static final Units MILE
```

FURLONG
```
public static final Units FURLONG
```

CHAIN
```
public static final Units CHAIN
```

ROD
```
public static final Units ROD
```

POLE
```
public static final Units POLE
```

PERCH
```
public static final Units PERCH
```

FATHOM
```
public static final Units FATHOM
```

YHARD
```
public static final Units YHARD
```

FOOT
```
public static final Units FOOT
```

HAND
```
public static final Units HAND
```

INCH
```
public static final Units INCH
```

MICORINCH
```
public static final Units MICORINCH
```

BANANA
```
public static final Units BANANA
```

NAUTICAL_MILE

public static final Units NAUTICAL_MILE

NAUTICAL_MILE_OLD_BRIT

public static final Units NAUTICAL_MILE_OLD_BRIT

NAUTICAL_MILE_OLD_US

public static final Units NAUTICAL_MILE_OLD_US

GIGAPARSEC
```
public static final Units GIGAPARSEC
```

MEGAPARSEC
```
public static final Units MEGAPARSEC
```

KILOPARSEC
```
public static final Units KILOPARSEC
```

PARSEC
```
public static final Units PARSEC
```

GIGALIGHT_YEAR

public static final Units GIGALIGHT_YEAR

MEGALIGHT_YEAR

public static final Units MEGALIGHT_YEAR

KILOLIGHT_YEAR

public static final Units KILOLIGHT_YEAR

LIGHT_YEAR
```
public static final Units LIGHT_YEAR
```

ASTRONOMICAL_UNIT

public static final Units ASTRONOMICAL_UNIT

KILOGRAM
```
public static final Units KILOGRAM
```

GRAM
```
public static final Units GRAM
```

DECIGRAM
```
public static final Units DECIGRAM
```

MILLIGRAM
```
public static final Units MILLIGRAM
```

MICROGRAM
```
public static final Units MICROGRAM
```

TONNE
```
public static final Units TONNE
```

METRIC_TON
```
public static final Units METRIC_TON
```

LONG_TON
```
public static final Units LONG_TON
```

SHORT_TON
```
public static final Units SHORT_TON
```

LONG_HUNDREDWEIGHT

public static final Units LONG_HUNDREDWEIGHT

SHORT_HUNDREDWEIGHT

public static final Units SHORT_HUNDREDWEIGHT

LONG_QUARTER
```
public static final Units LONG_QUARTER
```

SHORT_QUARTER

public static final Units SHORT_QUARTER

STONE
```
public static final Units STONE
```

POUND
```
public static final Units POUND
```

OUNCE
```
public static final Units OUNCE
```

DRACHM
```
public static final Units DRACHM
```

GRAIN
```
public static final Units GRAIN
```

TROY_POUND
```
public static final Units TROY_POUND
```

TROY_OUNCE
```
public static final Units TROY_OUNCE
```

PENNYWEIGHT
```
public static final Units PENNYWEIGHT
```

CARAT
```
public static final Units CARAT
```

DEGREE_CELSIUS

public static final Units DEGREE_CELSIUS

DEGREE_FAHRENHEIT

public static final Units DEGREE_FAHRENHEIT

KELVIN
```
public static final Units KELVIN
```

KILOELECTRONVOLT

public static final Units KILOELECTRONVOLT

DEGREE_RANKINE

public static final Units DEGREE_RANKINE

Method Detail
- values
```
public static Units[] 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 (Units c : Units.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static Units 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
- getScale
```
public final double getScale()
```
- getOffset
```
public final double getOffset()
```
- getSymbol
```
public final String getSymbol()
```
- getName
```
public final String getName()
```
- getAltCodes
```
public final String[] getAltCodes()
```
- getDefaultCvt
```
public final DefCvt getDefaultCvt()
```
- getPluralName
```
public final String getPluralName()
```
  Gets the plural form of the Unit (e.g. "feet" is the plural of "foot"). When no specific plural was set, the regular name with an appended "s" is returned.
  
  Returns:
  
  The plural form of the Unit name.
- getUsName
```
public final String getUsName()
```
  Gets the U.S. name if available (e.g. "meter" instead of "metre").
  
  Returns:
  
  The U.S. name or null if not available.
- searchUnitFromName
```
public static Units searchUnitFromName(String name)
```
  Searches the Unit according to the given name.
  
  Parameters:
  
  name - The official name, symbol or alternating code for the Unit.
  
  Returns:
  
  The Unit corresponding to the name or null if no match was found.
- isSameUnitType
```
public static boolean isSameUnitType(Units a,
                                     Units b)
```
  Checks if two units are from the same type (e.g. UnitType.LENGTH).
  
  Parameters:
  
  a - The first unit for comparison.
  
  b - The second unit for comparison.
  
  Returns:
  
  True if the type of the units are equal.

Enum Units

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GRAY

RAD

CENTIMETRE_PER_SEC_SQ

FOOT_PER_SEC_SQ

STANDARD_GRAVITY

KILOMETRE_PER_H_PER_SEC

KILOMETRE_PER_SEC_SQ

METRE_PER_SEC_SQ

MILE_PER_H_PER_SEC

SQUARE_KILOMETRE

SQUARE_HECTOMETRE

SQUARE_DECAMETRE

SQUARE_METRE

SQUARE_DECIMETRE

SQUARE_CENTIMETRE

SQUARE_MILLIMETRE

THOUSAND_SQFT

ARE

ACRE

ARPENT

CUERDA

DAA

DUNAM

DUNUM

HECTARE

IRISH_ACRE

PONDEMAAT

PYEONG

RAI

ROOD

SQUARE_FOOT

SQUARE_FOOT2

SQUARE_INCH

SQUARE_NAUTICAL_MILE

SQUARE_MILE

SQUARE_PERCH

SQUARE_VERST

SQUARE_YARD

TSUBO

M2_PER_HA

SQFT_PER_ACRE

CENT

AMPERE_HOUR

COULOMB

E

GRAM_MOLE

GRAM_MOLE2

KILOMOLE

POUND_MOLE

POUND_MOLE2

MOLE

KILOGRAM_PER_LITRE

POUNT_PER_US_GAL

GRAMM_PER_CUBIC_DM

GRAM_PER_LITRE

GRAM_PER_ML

KILOGRAM_PER_DM3

KILOGRAMM_PER_LITRE

KILOGRAMM_PER_CUBIC_M

POUND_PER_CUBIC_FT

POUND_PER_CUBIC_IN

POUND_PER_CUBIC_IN2

POUND_PER_CUBIC_YD

POUND_PER_IMP_GAL

POUND_PER_US_GAL

POUND_PER_US_GAL2

POUND_PER_US_BUSHEL

POUND_MASS_PER_CUBIC_IN

MILLIGRAM_PER_LITRE

OUNCE_PER_CUBIC_IN

BOARD_OF_TRADE_UNIT

BARREL_OF_OIL_EQUIVALENT

BARREL_OF_OIL_EQUIVALENT2

BTU