Duration (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.util.Duration

All Implemented Interfaces:

java.lang.Comparable<Duration>, IStringRepresentation
```
public class Duration
extends java.lang.Object
implements java.lang.Comparable<Duration>, IStringRepresentation
```
Time duration split-up in days, hours, minutes, seconds and milliseconds. Instances of this class are immutable.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_FORMAT`
`static long`	`MILLIS_PER_DAY`
`static long`	`MILLIS_PER_HOUR`
`static long`	`MILLIS_PER_MINUTE`
`static long`	`MILLIS_PER_SECOND`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Duration(long fullDurationInMillis)

Constructors
Modifier	Constructor and Description
`protected`	`Duration(long fullDurationInMillis)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`asMilliseconds()` Returns the full duration as milliseconds.
`java.lang.String`	`asString()` Returns the duration as a string using english text labels as suffix after each value.
`java.lang.String`	`asString(java.lang.String daysText, java.lang.String hoursText, java.lang.String minutesText, java.lang.String secondsText, java.lang.String millisText)` Returns the duration as a string using the given text labels as suffix after each value.
`int`	`compareTo(Duration other)`
`static Duration`	`create(int milliseconds)` Creates a new instance based on the given milliseconds.
`static Duration`	`create(int seconds, int milliseconds)` Creates a new instance based on the given values.
`static Duration`	`create(int minutes, int seconds, int milliseconds)` Creates a new instance based on the given values.
`static Duration`	`create(int hours, int minutes, int seconds, int milliseconds)` Creates a new instance based on the given values.
`static Duration`	`create(long days, int hours, int minutes, int seconds, int milliseconds)` Creates a new instance based on the given values.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`format(java.lang.String template)` Formats the duration into a string utilizing the given template.
`long`	`getDays()` Returns the number of days.
`protected long`	`getFullDurationInMillis()`
`int`	`getHours()` Returns the number of hours.
`int`	`getMilliseconds()` Returns the number of milliseconds.
`int`	`getMinutes()` Returns the number of minutes.
`int`	`getSeconds()` Returns the number of seconds.
`int`	`hashCode()`
`boolean`	`isInDaysRange()` Returns true if the duration is not under a day.
`boolean`	`isInHoursRange()` Returns true if the duration is not under an hour.
`boolean`	`isInMinutesRange()` Returns true if the duration is not under a minute.
`boolean`	`isInSecondsRange()` Returns true if the duration is not under a second.
`protected java.lang.String`	`replacePlaceholder(java.lang.String string, java.lang.String placeholder, boolean isInRange, long value)`
`java.lang.String`	`toString()`
`static Duration`	`valueOf(long fullDurationInMillis)` Creates a new instance based on the given milliseconds.

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

- Field Detail
  - MILLIS_PER_SECOND
```
public static final long MILLIS_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - MILLIS_PER_MINUTE
```
public static final long MILLIS_PER_MINUTE
```
    See Also:
    
    Constant Field Values
  - MILLIS_PER_HOUR
```
public static final long MILLIS_PER_HOUR
```
    See Also:
    
    Constant Field Values
  - MILLIS_PER_DAY
```
public static final long MILLIS_PER_DAY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FORMAT
```
public static final java.lang.String DEFAULT_FORMAT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Duration
```
protected Duration(long fullDurationInMillis)
```
- Method Detail
  - valueOf
```
public static Duration valueOf(long fullDurationInMillis)
```
    Creates a new instance based on the given milliseconds.
    
    Parameters:
    
    fullDurationInMillis - The duration in milliseconds.
    
    Returns:
    
    A new Duration instance that is equivalent to the given duration in milliseconds.
  - create
```
public static Duration create(int milliseconds)
```
    Creates a new instance based on the given milliseconds. If the duration exceeds 999 milliseconds use valueOf(long) instead!
    
    Parameters:
    
    milliseconds - The number of milliseconds - must be a value in the range of 0..999.
    
    Returns:
    
    A new Duration instance initialized with the given values.
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the given values is outside the allowed range.
  - create
```
public static Duration create(int seconds,
                              int milliseconds)
```
    Creates a new instance based on the given values.
    
    Parameters:
    
    seconds - The number of seconds - must be a value in the range of 0..59.
    
    milliseconds - The number of milliseconds - must be a value in the range of 0..999.
    
    Returns:
    
    A new Duration instance initialized with the given values.
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the given values is outside the allowed range.
  - create
```
public static Duration create(int minutes,
                              int seconds,
                              int milliseconds)
```
    Creates a new instance based on the given values.
    
    Parameters:
    
    minutes - The number of minutes - must be a value in the range of 0..59.
    
    seconds - The number of seconds - must be a value in the range of 0..59.
    
    milliseconds - The number of milliseconds - must be a value in the range of 0..999.
    
    Returns:
    
    A new Duration instance initialized with the given values.
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the given values is outside the allowed range.
  - create
```
public static Duration create(int hours,
                              int minutes,
                              int seconds,
                              int milliseconds)
```
    Creates a new instance based on the given values.
    
    Parameters:
    
    hours - The number of hours - must be a value in the range of 0..24.
    
    minutes - The number of minutes - must be a value in the range of 0..59.
    
    seconds - The number of seconds - must be a value in the range of 0..59.
    
    milliseconds - The number of milliseconds - must be a value in the range of 0..999.
    
    Returns:
    
    A new Duration instance initialized with the given values.
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the given values is outside the allowed range.
  - create
```
public static Duration create(long days,
                              int hours,
                              int minutes,
                              int seconds,
                              int milliseconds)
```
    Creates a new instance based on the given values.
    
    Parameters:
    
    days - The number of days - must be a value in the range of 0..106751991166.
    
    hours - The number of hours - must be a value in the range of 0..24.
    
    minutes - The number of minutes - must be a value in the range of 0..59.
    
    seconds - The number of seconds - must be a value in the range of 0..59.
    
    milliseconds - The number of milliseconds - must be a value in the range of 0..999.
    
    Returns:
    
    A new Duration instance initialized with the given values.
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the given values is outside the allowed range.
  - getDays
```
public long getDays()
```
    Returns the number of days.
  - getHours
```
public int getHours()
```
    Returns the number of hours.
  - getMinutes
```
public int getMinutes()
```
    Returns the number of minutes.
  - getSeconds
```
public int getSeconds()
```
    Returns the number of seconds.
  - getMilliseconds
```
public int getMilliseconds()
```
    Returns the number of milliseconds.
  - asMilliseconds
```
public long asMilliseconds()
```
    Returns the full duration as milliseconds.
  - isInDaysRange
```
public boolean isInDaysRange()
```
    Returns true if the duration is not under a day.
  - isInHoursRange
```
public boolean isInHoursRange()
```
    Returns true if the duration is not under an hour.
  - isInMinutesRange
```
public boolean isInMinutesRange()
```
    Returns true if the duration is not under a minute.
  - isInSecondsRange
```
public boolean isInSecondsRange()
```
    Returns true if the duration is not under a second.
  - asString
```
public java.lang.String asString()
```
    Returns the duration as a string using english text labels as suffix after each value. The string will start at the largest set unit.
    
    Specified by:
    
    asString in interface IStringRepresentation
  - asString
```
public java.lang.String asString(java.lang.String daysText,
                                 java.lang.String hoursText,
                                 java.lang.String minutesText,
                                 java.lang.String secondsText,
                                 java.lang.String millisText)
```
    Returns the duration as a string using the given text labels as suffix after each value. The string will start at the largest set unit.
  - format
```
public java.lang.String format(java.lang.String template)
```
    Formats the duration into a string utilizing the given template. The template can have the following placeholders that will be replaced accordingly by the corresponding values.
    - %d - days
    - %h - hours
    - %m - minutes
    - %s - seconds
    - %t - milliseconds
    Parameters:
    
    template - The template with placeholders to be used for formatting (must not be null).
    
    Returns:
    
    The formatted string.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - compareTo
```
public int compareTo(Duration other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Duration>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - replacePlaceholder
```
protected java.lang.String replacePlaceholder(java.lang.String string,
                                              java.lang.String placeholder,
                                              boolean isInRange,
                                              long value)
```
  - getFullDurationInMillis
```
protected long getFullDurationInMillis()
```

Class Duration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MILLIS_PER_SECOND

MILLIS_PER_MINUTE

MILLIS_PER_HOUR

MILLIS_PER_DAY

DEFAULT_FORMAT

Constructor Detail

Duration

Method Detail

valueOf

create

create

create

create

create

getDays

getHours

getMinutes

getSeconds

getMilliseconds

asMilliseconds

isInDaysRange

isInHoursRange

isInMinutesRange

isInSecondsRange

asString

asString

format

hashCode

equals

compareTo

toString

replacePlaceholder

getFullDurationInMillis