TimeSize

java.lang.Object
- java.lang.Enum<TimeSize>
- - com.screenscraper.profiling.session.units.TimeSize

All Implemented Interfaces:

MeasureEnum<TimeSize>, java.io.Serializable, java.lang.Comparable<TimeSize>
```
public enum TimeSize
extends java.lang.Enum<TimeSize>
implements MeasureEnum<TimeSize>
```
Represents units of time

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Century` Century
`Day` Day
`Decade` Decade
`Fortnight` A fortnight
`Hour` Hour
`Microsecond` Microsecond
`Millennium` Millenium
`Millisecond` Millisecond
`Minute` One minute
`Month` Month, as 1/12th of a year
`Nanosecond` Nanosecond
`Second` Second
`Week` A week
`Year` Year, as 365 days

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAbbreviation()` Returns the most common abbreviation for this measure
`java.util.Collection<java.lang.String>`	`getAbbreviations()` Returns a set of all possible abbreviations for this unit
`TimeSize`	`getBaseUnit()` Returns the base unit used as a base in this type
`RationalNumber`	`getConversionRateFromBase()` Gets a rational number that represents the conversion rate from the a base size to this size.
`RationalNumber`	`getConversionRateTo(TimeSize size)` Gets a rational number that represents the conversion rate from the a base size to this size.
`RationalNumber`	`getConversionRateToBase()` Gets a rational number that represents the conversion rate from the given size to the base measure for this size.
`MeasurementSystem`	`getMeasurementSystem()` Returns the measurement system this is a part of
`java.lang.String`	`getName()` Returns the name of this measure.
`java.lang.String`	`getPluralName()` Returns the name of this measure in plural.
`static java.util.List<TimeSize>`	`getSmallestToLargest()` Returns all the sizes, sorted from smallest to largest
`static TimeSize`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static TimeSize[]`	`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
  - Minute
```
public static final TimeSize Minute
```
    One minute
  - Second
```
public static final TimeSize Second
```
    Second
  - Millisecond
```
public static final TimeSize Millisecond
```
    Millisecond
  - Microsecond
```
public static final TimeSize Microsecond
```
    Microsecond
  - Nanosecond
```
public static final TimeSize Nanosecond
```
    Nanosecond
  - Hour
```
public static final TimeSize Hour
```
    Hour
  - Day
```
public static final TimeSize Day
```
    Day
  - Week
```
public static final TimeSize Week
```
    A week
  - Fortnight
```
public static final TimeSize Fortnight
```
    A fortnight
  - Year
```
public static final TimeSize Year
```
    Year, as 365 days
  - Month
```
public static final TimeSize Month
```
    Month, as 1/12th of a year
  - Decade
```
public static final TimeSize Decade
```
    Decade
  - Century
```
public static final TimeSize Century
```
    Century
  - Millennium
```
public static final TimeSize Millennium
```
    Millenium
- Method Detail
  - values
```
public static TimeSize[] 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 (TimeSize c : TimeSize.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TimeSize valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getBaseUnit
```
@NotNull
public TimeSize getBaseUnit()
```
    Description copied from interface: MeasureEnum
    
    Returns the base unit used as a base in this type
    
    Specified by:
    
    getBaseUnit in interface MeasureEnum<TimeSize>
    
    Returns:
    
    The unit being used as the base
  - getAbbreviation
```
@Nullable
public java.lang.String getAbbreviation()
```
    Description copied from interface: MeasureEnum
    
    Returns the most common abbreviation for this measure
    
    Specified by:
    
    getAbbreviation in interface MeasureEnum<TimeSize>
    
    Returns:
    
    The abbreviation for the measurement
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: MeasureEnum
    
    Returns the name of this measure. This is given since some measures will match keywords, etc...
    
    Specified by:
    
    getName in interface MeasureEnum<TimeSize>
    
    Returns:
    
    The name of this measurement
  - getPluralName
```
public java.lang.String getPluralName()
```
    Description copied from interface: MeasureEnum
    
    Returns the name of this measure in plural.
    
    Specified by:
    
    getPluralName in interface MeasureEnum<TimeSize>
    
    Returns:
    
    The name of this measurement in plural form
  - getConversionRateToBase
```
public RationalNumber getConversionRateToBase()
```
    Description copied from interface: MeasureEnum
    
    Gets a rational number that represents the conversion rate from the given size to the base measure for this size. The base measure is simply defined by each class, and is used to convert between sizes
    
    Specified by:
    
    getConversionRateToBase in interface MeasureEnum<TimeSize>
    
    Returns:
    
    The conversion rate to a base size
  - getConversionRateFromBase
```
public RationalNumber getConversionRateFromBase()
```
    Description copied from interface: MeasureEnum
    
    Gets a rational number that represents the conversion rate from the a base size to this size.
    
    Specified by:
    
    getConversionRateFromBase in interface MeasureEnum<TimeSize>
    
    Returns:
    
    The conversion rate from a base size to this size
  - getConversionRateTo
```
public RationalNumber getConversionRateTo(@NotNull
                                          TimeSize size)
```
    Description copied from interface: MeasureEnum
    
    Gets a rational number that represents the conversion rate from the a base size to this size.
    
    Specified by:
    
    getConversionRateTo in interface MeasureEnum<TimeSize>
    
    Parameters:
    
    size - The size to convert to
    
    Returns:
    
    The conversion rate from a base size to this size
  - getMeasurementSystem
```
public MeasurementSystem getMeasurementSystem()
```
    Description copied from interface: MeasureEnum
    
    Returns the measurement system this is a part of
    
    Specified by:
    
    getMeasurementSystem in interface MeasureEnum<TimeSize>
    
    Returns:
    
    The measurement system this is a part of
  - getAbbreviations
```
public java.util.Collection<java.lang.String> getAbbreviations()
```
    Description copied from interface: MeasureEnum
    
    Returns a set of all possible abbreviations for this unit
    
    Specified by:
    
    getAbbreviations in interface MeasureEnum<TimeSize>
    
    Returns:
    
    All possible abbreviations for this unit
  - getSmallestToLargest
```
@NotNull
public static java.util.List<TimeSize> getSmallestToLargest()
```
    Returns all the sizes, sorted from smallest to largest
    
    Returns:
    
    The sizes, sorted from smallest to largest

Enum TimeSize

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Minute

Second

Millisecond

Microsecond

Nanosecond

Hour

Day

Week

Fortnight

Year

Month

Decade

Century

Millennium

Method Detail

values

valueOf

getBaseUnit

getAbbreviation

getName

getPluralName

getConversionRateToBase

getConversionRateFromBase

getConversionRateTo

getMeasurementSystem

getAbbreviations

getSmallestToLargest