TimeSpanUnit (JHCaching 0.8 API)

java.lang.Object
- java.lang.Enum<TimeSpanUnit>
- - dk.heick.caching.utils.TimeSpanUnit

All Implemented Interfaces:

Serializable, Comparable<TimeSpanUnit>
```
public enum TimeSpanUnit
extends Enum<TimeSpanUnit>
```
Unit enum for TimeSpan.

Since:

2.0

Author:

Frederik Heick

Enum Constant Summary

Enum Constants
Enum Constant and Description
`d` Day = Hour*24
`D` Day = Hour*24
`h` Hour = Minute*60
`H` Hour = Minute*60
`m` Minute = Second*60
`M` Month = Day*31
`ms` Millisecond = 1
`s` Second = Millisecond*1000
`S` Second = Millisecond*1000
`w` Week = Day*7
`W` Week = Day*7
`y` Year = Day*365
`Y` Year = Day*365

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getUnitName()` The unit name
`String`	`getUnitName(long value)` The unit name as singular or prural.
`long`	`getUnitSpanInMilliSeconds()` The unit timespan in milliseconds.
`long`	`toMilliSeconds(double value)` Converts the enum TimeSpanUnit into milliseconds.
`static TimeSpanUnit`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TimeSpanUnit[]`	`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
  - ms
```
public static final TimeSpanUnit ms
```
    Millisecond = 1
  - s
```
public static final TimeSpanUnit s
```
    Second = Millisecond*1000
  - S
```
public static final TimeSpanUnit S
```
    Second = Millisecond*1000
  - m
```
public static final TimeSpanUnit m
```
    Minute = Second*60
  - h
```
public static final TimeSpanUnit h
```
    Hour = Minute*60
  - H
```
public static final TimeSpanUnit H
```
    Hour = Minute*60
  - d
```
public static final TimeSpanUnit d
```
    Day = Hour*24
  - D
```
public static final TimeSpanUnit D
```
    Day = Hour*24
  - w
```
public static final TimeSpanUnit w
```
    Week = Day*7
  - W
```
public static final TimeSpanUnit W
```
    Week = Day*7
  - M
```
public static final TimeSpanUnit M
```
    Month = Day*31
  - y
```
public static final TimeSpanUnit y
```
    Year = Day*365
  - Y
```
public static final TimeSpanUnit Y
```
    Year = Day*365
- Method Detail
  - values
```
public static TimeSpanUnit[] 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 (TimeSpanUnit c : TimeSpanUnit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TimeSpanUnit 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
  - getUnitName
```
public String getUnitName()
```
    The unit name
    
    Returns:
    
    the unitName
  - getUnitSpanInMilliSeconds
```
public long getUnitSpanInMilliSeconds()
```
    The unit timespan in milliseconds.
    
    Returns:
    
    the unit as milliseconds.
  - toMilliSeconds
```
public long toMilliSeconds(double value)
```
    Converts the enum TimeSpanUnit into milliseconds.
    
    Parameters:
    
    value - how many parts of the TimeSpan Unit
    
    Returns:
    
    the enum value as milliseconds.
  - getUnitName
```
public String getUnitName(long value)
```
    The unit name as singular or prural.
    
    Parameters:
    
    value - if the value is greather the "1" than a "s" is added to the unit name, otherwise the unit name is returned.
    
    Returns:
    
    if the value is greater than 1, than and "s" is added to the the unit name.
    
    See Also:
    
    getUnitName()

Enum TimeSpanUnit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ms

s

S

m

h

H

d

D

w

W

M

y

Y

Method Detail

values

valueOf

getUnitName

getUnitSpanInMilliSeconds

toMilliSeconds

getUnitName