TimePeriod (timeseries 0.4 API)

java.lang.Object
- com.github.signaflo.timeseries.TimePeriod

```
public final class TimePeriod
extends Object
```
An amount of time expressed in a particular time unit. This class wraps a TimeUnit together with a positive integer period length, allowing one to create a wide range of different time periods. This class is immutable and thread-safe.

Constructor Summary

Constructors
Constructor and Description

TimePeriod(TimeUnit timeUnit, long periodLength)
Create a new time period with the given unit of time and period length.

Constructors
Constructor and Description
`TimePeriod(TimeUnit timeUnit, long periodLength)` Create a new time period with the given unit of time and period length.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`double`	`frequencyPer(TimePeriod otherTimePeriod)` Compute and return the number of times this time period occurs in the given time period.
`static TimePeriod`	`halfCentury()` Create and return a new TimePeriod representing one half of a century
`static TimePeriod`	`halfDay()` Create and return a new TimePeriod representing one half of a day.
`static TimePeriod`	`halfDecade()` Create and return a new TimePeriod representing one half of a decade.
`static TimePeriod`	`halfHour()` Create and return a new TimePeriod representing one half of an hour.
`static TimePeriod`	`halfMonth()` Create and return a new TimePeriod representing one half of a month.
`static TimePeriod`	`halfSecond()` Create and return a new TimePeriod representing one half of a second.
`static TimePeriod`	`halfYear()` Create and return a new TimePeriod representing one half of a year.
`int`	`hashCode()`
`static TimePeriod`	`oneCentury()` Create and return a new TimePeriod representing exactly one century.
`static TimePeriod`	`oneDay()` Create and return a new TimePeriod representing one day.
`static TimePeriod`	`oneDecade()` Create and return a new TimePeriod representing exactly one decade.
`static TimePeriod`	`oneHour()` Create and return a new TimePeriod representing exactly one hour.
`static TimePeriod`	`oneMonth()` Create and return a new TimePeriod representing exactly one month.
`static TimePeriod`	`oneQuarter()` Create and return a new TimePeriod representing one quarter of a year.
`static TimePeriod`	`oneSecond()` Create and return a new TimePeriod representing one second.
`static TimePeriod`	`oneTenthSecond()` Create and return a new TimePeriod representing one tenth of a second.
`static TimePeriod`	`oneWeek()` Create and return a new TimePeriod representing one week.
`static TimePeriod`	`oneYear()` Create and return a new TimePeriod representing exactly one year.
`long`	`periodLength()` The length of this time period relative to the underlying time unit.
`TimeUnit`	`timeUnit()` The unit of time underlying this time period.
`String`	`toString()`
`double`	`totalSeconds()` The total amount of time in this time period measured in seconds, the base SI unit of time.
`static TimePeriod`	`triAnnual()` Create and return a new TimePeriod representing one third of a year.
`static TimePeriod`	`twoYears()` Create and return a new TimePeriod representing exactly two years.
`long`	`unitLength()` The length of this time period expressed in terms of its underlying time unit.

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

- Constructor Detail
  - TimePeriod
```
public TimePeriod(TimeUnit timeUnit,
                  long periodLength)
```
    Create a new time period with the given unit of time and period length.
    
    Parameters:
    
    timeUnit - the unit of time underlying this time period
    
    periodLength - the length of this time period relative to the given unit of time. Note that the period length must be a long. Most decimal time periods can be modeled by converting to an appropriate time unit with a smaller order of magnitude. For example, the halfMonth() constructor works by converting 15.2184375 days to 1314873 seconds.
    
    Throws:
    
    IllegalArgumentException - if the given period length is less than or equal to 0.
- Method Detail
  - oneHour
```
public static TimePeriod oneHour()
```
    Create and return a new TimePeriod representing exactly one hour.
    
    Returns:
    
    a new TimePeriod representing exactly one hour.
  - oneYear
```
public static TimePeriod oneYear()
```
    Create and return a new TimePeriod representing exactly one year.
    
    Returns:
    
    a new TimePeriod representing exactly one year.
  - twoYears
```
public static TimePeriod twoYears()
```
    Create and return a new TimePeriod representing exactly two years.
    
    Returns:
    
    a new TimePeriod representing exactly two years.
  - halfDecade
```
public static TimePeriod halfDecade()
```
    Create and return a new TimePeriod representing one half of a decade.
    
    Returns:
    
    a new TimePeriod representing one half of a decade.
  - oneMonth
```
public static TimePeriod oneMonth()
```
    Create and return a new TimePeriod representing exactly one month.
    
    Returns:
    
    a new TimePeriod representing exactly one month.
  - halfMonth
```
public static TimePeriod halfMonth()
```
    Create and return a new TimePeriod representing one half of a month.
    
    Returns:
    
    a new TimePeriod representing one half of a month.
  - oneQuarter
```
public static TimePeriod oneQuarter()
```
    Create and return a new TimePeriod representing one quarter of a year.
    
    Returns:
    
    a new TimePeriod representing one quarter of a year.
  - oneWeek
```
public static TimePeriod oneWeek()
```
    Create and return a new TimePeriod representing one week.
    
    Returns:
    
    a new TimePeriod representing one week.
  - oneDay
```
public static TimePeriod oneDay()
```
    Create and return a new TimePeriod representing one day.
    
    Returns:
    
    a new TimePeriod representing one day.
  - halfYear
```
public static TimePeriod halfYear()
```
    Create and return a new TimePeriod representing one half of a year.
    
    Returns:
    
    a new TimePeriod representing one half of a year.
  - oneDecade
```
public static TimePeriod oneDecade()
```
    Create and return a new TimePeriod representing exactly one decade.
    
    Returns:
    
    a new TimePeriod representing exactly one decade.
  - halfCentury
```
public static TimePeriod halfCentury()
```
    Create and return a new TimePeriod representing one half of a century
    
    Returns:
    
    a new TimePeriod representing one half of a century.
  - oneCentury
```
public static TimePeriod oneCentury()
```
    Create and return a new TimePeriod representing exactly one century.
    
    Returns:
    
    a new TimePeriod representing exactly one century.
  - halfHour
```
public static TimePeriod halfHour()
```
    Create and return a new TimePeriod representing one half of an hour.
    
    Returns:
    
    a new TimePeriod representing one half of an hour.
  - halfDay
```
public static TimePeriod halfDay()
```
    Create and return a new TimePeriod representing one half of a day.
    
    Returns:
    
    a new TimePeriod representing one half of a day.
  - triAnnual
```
public static TimePeriod triAnnual()
```
    Create and return a new TimePeriod representing one third of a year.
    
    Returns:
    
    a new TimePeriod representing one third of a year.
  - oneSecond
```
public static TimePeriod oneSecond()
```
    Create and return a new TimePeriod representing one second.
    
    Returns:
    
    a new TimePeriod representing one second.
  - halfSecond
```
public static TimePeriod halfSecond()
```
    Create and return a new TimePeriod representing one half of a second.
    
    Returns:
    
    a new TimePeriod representing one half of a second.
  - oneTenthSecond
```
public static TimePeriod oneTenthSecond()
```
    Create and return a new TimePeriod representing one tenth of a second.
    
    Returns:
    
    a new TimePeriod representing one tenth of a second.
  - timeUnit
```
public TimeUnit timeUnit()
```
    The unit of time underlying this time period.
    
    Returns:
    
    the unit of time underlying this time period.
  - periodLength
```
public long periodLength()
```
    The length of this time period relative to the underlying time unit.
    
    Returns:
    
    the length of this time period relative to the underlying time unit.
  - unitLength
```
public long unitLength()
```
    The length of this time period expressed in terms of its underlying time unit.
    
    Returns:
    
    the length of this time period expressed in terms of its underlying time unit.
  - frequencyPer
```
public double frequencyPer(TimePeriod otherTimePeriod)
```
    Compute and return the number of times this time period occurs in the given time period.
    For example, if this time period is a month and the given time period is half a year, the return value is 6 since a month occurs 6 times in one year.
    
    Parameters:
    
    otherTimePeriod - the time period for which the frequency of occurrence of this time period is to be found.
    
    Returns:
    
    the number of times this time period occurs in the provided time period.
  - totalSeconds
```
public double totalSeconds()
```
    The total amount of time in this time period measured in seconds, the base SI unit of time.
    
    Returns:
    
    the total amount of time in this time period measured in seconds.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class TimePeriod

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TimePeriod

Method Detail

oneHour

oneYear

twoYears

halfDecade

oneMonth

halfMonth

oneQuarter

oneWeek

oneDay

halfYear

oneDecade

halfCentury

oneCentury

halfHour

halfDay

triAnnual

oneSecond

halfSecond

oneTenthSecond

timeUnit

periodLength

unitLength

frequencyPer

totalSeconds

toString

hashCode

equals