TimeUnit (com.hfg API Documentation)

java.lang.Object
- com.hfg.units.Unit
- - com.hfg.units.TimeUnit

All Implemented Interfaces:

Comparable
```
public class TimeUnit
extends Unit
```
Enumeration of standard time units.

Field Summary

Fields
Modifier and Type	Field and Description
`static TimeUnit`	`day`
`static TimeUnit`	`hour`
`static TimeUnit`	`millisecond`
`static TimeUnit`	`minute`
`static TimeUnit`	`month`
`static TimeUnit`	`second`
`static TimeUnit`	`week`
`static TimeUnit`	`year`

Constructor Summary

Constructors
Modifier Constructor and Description

protected TimeUnit(List<SubUnit> inSubUnits)

Constructors
Modifier	Constructor and Description
`protected`	`TimeUnit(List<SubUnit> inSubUnits)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TimeUnit`	`addAlternateName(String inValue)`
`int`	`getCalendarNum()` Returns the associated int value to use with a Calendar object's get() method.
`long`	`getMilliseconds()` Returns the time unit's length in milliseconds.
`TimeUnit`	`setMeasurementSystem(MeasurementSystem inValue)`
`TimeUnit`	`setPlural(String inValue)`
`TimeUnit`	`setPluralAbbrev(String inValue)`
`static TimeUnit`	`valueOf(String inValue)` Returns the TimeUnit object that corresponds to the specified name or abbreviation string.
`static Collection<TimeUnit>`	`values()`

Methods inherited from class com.hfg.units.Unit
compareTo, compareTo, computeBaseSIValue, computeScaledValue, computeUnitLabel, computeValueFromBaseSIValue, equals, getAbbrev, getAlternateNames, getDenominator, getMathContext, getMeasurementSystem, getNumerator, getPlural, getPluralAbbrev, getPow, getQuantityType, getSubUnits, hashCode, hasSubUnits, name, setDefaultMathContext, setMathContext, toString, valueOf, valueOf

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

- Field Detail
  - second
```
public static final TimeUnit second
```
  - millisecond
```
public static final TimeUnit millisecond
```
  - minute
```
public static final TimeUnit minute
```
  - hour
```
public static final TimeUnit hour
```
  - day
```
public static final TimeUnit day
```
  - week
```
public static final TimeUnit week
```
  - month
```
public static final TimeUnit month
```
  - year
```
public static final TimeUnit year
```
- Constructor Detail
  - TimeUnit
```
protected TimeUnit(List<SubUnit> inSubUnits)
```
- Method Detail
  - values
```
public static Collection<TimeUnit> values()
```
  - valueOf
```
public static TimeUnit valueOf(String inValue)
```
    Returns the TimeUnit object that corresponds to the specified name or abbreviation string.
    
    Parameters:
    
    inValue - the string name or abbreviation value to be converted into a TimeUnit object
    
    Returns:
    
    the TimeUnit constant corresponding to the specified name or abbreviation
  - setMeasurementSystem
```
public TimeUnit setMeasurementSystem(MeasurementSystem inValue)
```
    Overrides:
    
    setMeasurementSystem in class Unit
  - setPlural
```
public TimeUnit setPlural(String inValue)
```
    Overrides:
    
    setPlural in class Unit
  - setPluralAbbrev
```
public TimeUnit setPluralAbbrev(String inValue)
```
    Overrides:
    
    setPluralAbbrev in class Unit
  - getCalendarNum
```
public int getCalendarNum()
```
    Returns the associated int value to use with a Calendar object's get() method.
    
    Returns:
    
    the Calendar object int value associated with this time unit.
  - getMilliseconds
```
public long getMilliseconds()
```
    Returns the time unit's length in milliseconds. Note that the values for MONTH and YEAR are approximations.
    
    Returns:
    
    the length of time in milliseconds that corresponds to this unit of time.
  - addAlternateName
```
public TimeUnit addAlternateName(String inValue)
```
    Overrides:
    
    addAlternateName in class Unit

Class TimeUnit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.hfg.units.Unit

Methods inherited from class java.lang.Object

Field Detail

second

millisecond

minute

hour

day

week

month

year

Constructor Detail

TimeUnit

Method Detail

values

valueOf

setMeasurementSystem

setPlural

setPluralAbbrev

getCalendarNum

getMilliseconds

addAlternateName