java.io.Serializable
, java.lang.Comparable<Hours>
, java.time.temporal.TemporalAmount
public final class Hours extends java.lang.Object implements java.time.temporal.TemporalAmount, java.lang.Comparable<Hours>, java.io.Serializable
This class models a quantity or amount of time in terms of hours. It is a type-safe way of representing a number of hours in an application.
The model is of a directed amount, meaning that the amount may be negative.
This class must be treated as a value type. Do not synchronize, rely on the identity hash code or use the distinction between equals() and ==.
Modifier and Type | Field | Description |
---|---|---|
static Hours |
ZERO |
A constant for zero hours.
|
Modifier and Type | Method | Description |
---|---|---|
Hours |
abs() |
Returns a copy of this duration with a positive length.
|
java.time.temporal.Temporal |
addTo(java.time.temporal.Temporal temporal) |
Adds this amount to the specified temporal object.
|
static Hours |
between(java.time.temporal.Temporal startInclusive,
java.time.temporal.Temporal endExclusive) |
Obtains a
Hours consisting of the number of hours between two temporals. |
int |
compareTo(Hours otherAmount) |
Compares this amount to the specified
Hours . |
Hours |
dividedBy(int divisor) |
Returns an instance with the amount divided by the specified divisor.
|
boolean |
equals(java.lang.Object otherAmount) |
Checks if this amount is equal to the specified
Hours . |
static Hours |
from(java.time.temporal.TemporalAmount amount) |
Obtains an instance of
Hours from a temporal amount. |
long |
get(java.time.temporal.TemporalUnit unit) |
Gets the value of the requested unit.
|
int |
getAmount() |
Gets the number of hours in this amount.
|
java.util.List<java.time.temporal.TemporalUnit> |
getUnits() |
Gets the set of units supported by this amount.
|
int |
hashCode() |
A hash code for this amount.
|
Hours |
minus(int hours) |
Returns a copy of this amount with the specified number of hours subtracted.
|
Hours |
minus(java.time.temporal.TemporalAmount amountToAdd) |
Returns a copy of this amount with the specified amount subtracted.
|
Hours |
multipliedBy(int scalar) |
Returns an instance with the amount multiplied by the specified scalar.
|
Hours |
negated() |
Returns an instance with the amount negated.
|
static Hours |
of(int hours) |
Obtains an
Hours representing a number of hours. |
static Hours |
parse(java.lang.CharSequence text) |
Obtains a
Hours from a text string such as PTnH . |
Hours |
plus(int hours) |
Returns a copy of this amount with the specified number of hours added.
|
Hours |
plus(java.time.temporal.TemporalAmount amountToAdd) |
Returns a copy of this amount with the specified amount added.
|
java.time.temporal.Temporal |
subtractFrom(java.time.temporal.Temporal temporal) |
Subtracts this amount from the specified temporal object.
|
java.time.Duration |
toDuration() |
Gets the number of hours as a
Duration . |
java.time.Duration |
toPeriod() |
Deprecated.
Use
toDuration() |
java.lang.String |
toString() |
Returns a string representation of the number of hours.
|
public static final Hours ZERO
public static Hours of(int hours)
Hours
representing a number of hours.
The resulting amount will have the specified hours.
hours
- the number of hours, positive or negativepublic static Hours from(java.time.temporal.TemporalAmount amount)
Hours
from a temporal amount.
This obtains an instance based on the specified amount.
A TemporalAmount
represents an amount of time, which may be
date-based or time-based, which this factory extracts to a Hours
.
The result is calculated by looping around each unit in the specified amount.
Each amount is converted to hours using Temporals.convertAmount(long, java.time.temporal.TemporalUnit, java.time.temporal.TemporalUnit)
.
If the conversion yields a remainder, an exception is thrown.
If the amount is zero, the unit is ignored.
amount
- the temporal amount to convert, not nulljava.time.DateTimeException
- if unable to convert to a Hours
java.lang.ArithmeticException
- if numeric overflow occurspublic static Hours parse(java.lang.CharSequence text)
Hours
from a text string such as PTnH
.
This will parse the string produced by toString()
and other
related formats based on ISO-8601 PnDTnH
.
The string starts with an optional sign, denoted by the ASCII negative
or positive symbol. If negative, the whole amount is negated.
The ASCII letter "P" is next in upper or lower case.
There are two sections consisting of a number and a suffix.
There is one section for days suffixed by "D",
followed by one section for hours suffixed by "H".
At least one section must be present.
If the hours section is present it must be prefixed by "T".
If the hours section is omitted the "T" must be omitted.
Letters must be in ASCII upper or lower case.
The number part of each section must consist of ASCII digits.
The number may be prefixed by the ASCII negative or positive symbol.
The number must parse to an int
.
The leading plus/minus sign, and negative values for days and hours are not part of the ISO-8601 standard.
For example, the following are valid inputs:
"PT2H" -- Hours.of(2) "PT-HM" -- Hours.of(-2) "-PT2H" -- Hours.of(-2) "-PT-2H" -- Hours.of(2) "P3D" -- Hours.of(3 * 24) "P3DT2H" -- Hours.of(3 * 24 + 2)
text
- the text to parse, not nulljava.time.format.DateTimeParseException
- if the text cannot be parsed to a periodpublic static Hours between(java.time.temporal.Temporal startInclusive, java.time.temporal.Temporal endExclusive)
Hours
consisting of the number of hours between two temporals.
The start temporal is included, but the end temporal is not. The result of this method can be negative if the end is before the start.
startInclusive
- the start temporal, inclusive, not nullendExclusive
- the end temporal, exclusive, not nullpublic long get(java.time.temporal.TemporalUnit unit)
This returns a value for the supported unit - HOURS
.
All other units throw an exception.
get
in interface java.time.temporal.TemporalAmount
unit
- the TemporalUnit
for which to return the valuejava.time.temporal.UnsupportedTemporalTypeException
- if the unit is not supportedpublic java.util.List<java.time.temporal.TemporalUnit> getUnits()
The single supported unit is HOURS
.
This set can be used in conjunction with get(TemporalUnit)
to
access the entire state of the amount.
getUnits
in interface java.time.temporal.TemporalAmount
public int getAmount()
public Hours plus(java.time.temporal.TemporalAmount amountToAdd)
The parameter is converted using from(TemporalAmount)
.
This instance is immutable and unaffected by this method call.
amountToAdd
- the amount to add, not nullHours
based on this instance with the requested amount added, not nulljava.time.DateTimeException
- if the specified amount contains an invalid unitjava.lang.ArithmeticException
- if numeric overflow occurspublic Hours plus(int hours)
This instance is immutable and unaffected by this method call.
hours
- the amount of hours to add, may be negativeHours
based on this instance with the requested amount added, not nulljava.lang.ArithmeticException
- if the result overflows an intpublic Hours minus(java.time.temporal.TemporalAmount amountToAdd)
The parameter is converted using from(TemporalAmount)
.
This instance is immutable and unaffected by this method call.
amountToAdd
- the amount to add, not nullHours
based on this instance with the requested amount subtracted, not nulljava.time.DateTimeException
- if the specified amount contains an invalid unitjava.lang.ArithmeticException
- if numeric overflow occurspublic Hours minus(int hours)
This instance is immutable and unaffected by this method call.
hours
- the amount of hours to add, may be negativeHours
based on this instance with the requested amount subtracted, not nulljava.lang.ArithmeticException
- if the result overflows an intpublic Hours multipliedBy(int scalar)
This instance is immutable and unaffected by this method call.
scalar
- the scalar to multiply by, not nulljava.lang.ArithmeticException
- if numeric overflow occurspublic Hours dividedBy(int divisor)
The calculation uses integer division, thus 3 divided by 2 is 1.
This instance is immutable and unaffected by this method call.
divisor
- the amount to divide by, may be negativejava.lang.ArithmeticException
- if the divisor is zeropublic Hours negated()
This instance is immutable and unaffected by this method call.
java.lang.ArithmeticException
- if numeric overflow occurs, which only happens if
the amount is Long.MIN_VALUE
public Hours abs()
This method returns a positive duration by effectively removing the sign from any negative total length.
This instance is immutable and unaffected by this method call.
java.lang.ArithmeticException
- if numeric overflow occurs, which only happens if
the amount is Long.MIN_VALUE
@Deprecated public java.time.Duration toPeriod()
toDuration()
Duration
.
This returns a duration with the same number of hours.
public java.time.Duration toDuration()
Duration
.
This returns a duration with the same number of hours.
public java.time.temporal.Temporal addTo(java.time.temporal.Temporal temporal)
This returns a temporal object of the same observable type as the input with this amount added.
In most cases, it is clearer to reverse the calling pattern by using
Temporal.plus(TemporalAmount)
.
// these two lines are equivalent, but the second approach is recommended dateTime = thisAmount.addTo(dateTime); dateTime = dateTime.plus(thisAmount);
Only non-zero amounts will be added.
This instance is immutable and unaffected by this method call.
addTo
in interface java.time.temporal.TemporalAmount
temporal
- the temporal object to adjust, not nulljava.time.DateTimeException
- if unable to addjava.time.temporal.UnsupportedTemporalTypeException
- if the HOURS unit is not supportedjava.lang.ArithmeticException
- if numeric overflow occurspublic java.time.temporal.Temporal subtractFrom(java.time.temporal.Temporal temporal)
This returns a temporal object of the same observable type as the input with this amount subtracted.
In most cases, it is clearer to reverse the calling pattern by using
Temporal.minus(TemporalAmount)
.
// these two lines are equivalent, but the second approach is recommended dateTime = thisAmount.subtractFrom(dateTime); dateTime = dateTime.minus(thisAmount);
Only non-zero amounts will be subtracted.
This instance is immutable and unaffected by this method call.
subtractFrom
in interface java.time.temporal.TemporalAmount
temporal
- the temporal object to adjust, not nulljava.time.DateTimeException
- if unable to subtractjava.time.temporal.UnsupportedTemporalTypeException
- if the HOURS unit is not supportedjava.lang.ArithmeticException
- if numeric overflow occurspublic int compareTo(Hours otherAmount)
Hours
.
The comparison is based on the total length of the amounts.
It is "consistent with equals", as defined by Comparable
.
compareTo
in interface java.lang.Comparable<Hours>
otherAmount
- the other amount, not nullpublic boolean equals(java.lang.Object otherAmount)
Hours
.
The comparison is based on the total length of the durations.
equals
in class java.lang.Object
otherAmount
- the other amount, null returns falsepublic int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2010–2018 ThreeTen.org. All rights reserved.