java.lang.Object | ||
↳ | org.joda.time.base.BaseSingleFieldPeriod | |
↳ | org.joda.time.Hours |
An immutable time period representing a number of hours.
Hours
is an immutable period that can only store hours.
It does not store years, months or minutes for example. As such it is a
type-safe way of representing a number of hours in an application.
The number of hours is set in the constructor, and may be queried using
getHours()
. Basic mathematical operations are provided -
plus()
, minus()
, multipliedBy()
and
dividedBy()
.
Hours
is thread-safe and immutable.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
EIGHT | Constant representing eight hours. | ||||||||||
FIVE | Constant representing five hours. | ||||||||||
FOUR | Constant representing four hours. | ||||||||||
MAX_VALUE | Constant representing the maximum number of hours that can be stored in this object. | ||||||||||
MIN_VALUE | Constant representing the minimum number of hours that can be stored in this object. | ||||||||||
ONE | Constant representing one hour. | ||||||||||
SEVEN | Constant representing seven hours. | ||||||||||
SIX | Constant representing six hours. | ||||||||||
THREE | Constant representing three hours. | ||||||||||
TWO | Constant representing two hours. | ||||||||||
ZERO | Constant representing zero hours. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns a new instance with the hours divided by the specified divisor.
| |||||||||||
Gets the duration field type, which is
hours . | |||||||||||
Gets the number of hours that this period represents.
| |||||||||||
Gets the period type, which is
hours . | |||||||||||
Obtains an instance of
Hours that may be cached. | |||||||||||
Creates a
Hours representing the number of whole hours
between the two specified datetimes. | |||||||||||
Creates a
Hours representing the number of whole hours
between the two specified partial datetimes. | |||||||||||
Creates a
Hours representing the number of whole hours
in the specified interval. | |||||||||||
Is this hours instance greater than the specified number of hours.
| |||||||||||
Is this hours instance less than the specified number of hours.
| |||||||||||
Returns a new instance with the specified number of hours taken away.
| |||||||||||
Returns a new instance with the specified number of hours taken away.
| |||||||||||
Returns a new instance with the hours multiplied by the specified scalar.
| |||||||||||
Returns a new instance with the hours value negated.
| |||||||||||
Creates a new
Hours by parsing a string in the ISO8601 format 'PTnH'. | |||||||||||
Returns a new instance with the specified number of hours added.
| |||||||||||
Returns a new instance with the specified number of hours added.
| |||||||||||
Creates a new
Hours representing the number of complete
standard length hours in the specified period. | |||||||||||
Converts this period in hours to a period in days assuming a
24 hour day.
| |||||||||||
Converts this period in hours to a duration in milliseconds assuming a
60 minute hour and 60 second minute.
| |||||||||||
Converts this period in hours to a period in minutes assuming a
60 minute hour.
| |||||||||||
Converts this period in hours to a period in seconds assuming a
60 minute hour and 60 second minute.
| |||||||||||
Converts this period in hours to a period in weeks assuming a
7 day week and 24 hour day.
| |||||||||||
Gets this instance as a String in the ISO8601 duration format.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.joda.time.base.BaseSingleFieldPeriod
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
| |||||||||||
From interface
org.joda.time.ReadablePeriod
|
Constant representing the maximum number of hours that can be stored in this object.
Constant representing the minimum number of hours that can be stored in this object.
Returns a new instance with the hours divided by the specified 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 negative |
---|
ArithmeticException | if the divisor is zero |
---|
Gets the duration field type, which is hours
.
Gets the number of hours that this period represents.
Obtains an instance of Hours
that may be cached.
Hours
is immutable, so instances can be cached and shared.
This factory method provides access to shared instances.
hours | the number of hours to obtain an instance for |
---|
Creates a Hours
representing the number of whole hours
between the two specified datetimes.
start | the start instant, must not be null |
---|---|
end | the end instant, must not be null |
IllegalArgumentException | if the instants are null or invalid |
---|
Creates a Hours
representing the number of whole hours
between the two specified partial datetimes.
The two partials must contain the same fields, for example you can specify
two LocalTime
objects.
start | the start partial date, must not be null |
---|---|
end | the end partial date, must not be null |
IllegalArgumentException | if the partials are null or invalid |
---|
Creates a Hours
representing the number of whole hours
in the specified interval.
interval | the interval to extract hours from, null returns zero |
---|
IllegalArgumentException | if the partials are null or invalid |
---|
Is this hours instance greater than the specified number of hours.
other | the other period, null means zero |
---|
Is this hours instance less than the specified number of hours.
other | the other period, null means zero |
---|
Returns a new instance with the specified number of hours taken away.
This instance is immutable and unaffected by this method call.
hours | the amount of hours to take away, may be negative, null means zero |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the specified number of hours taken away.
This instance is immutable and unaffected by this method call.
hours | the amount of hours to take away, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the hours multiplied by the specified scalar.
This instance is immutable and unaffected by this method call.
scalar | the amount to multiply by, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the hours value negated.
ArithmeticException | if the result overflows an int |
---|
Creates a new Hours
by parsing a string in the ISO8601 format 'PTnH'.
The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the hours component may be non-zero. If any other component is non-zero, an exception will be thrown.
periodStr | the period string, null returns zero |
---|
IllegalArgumentException | if the string format is invalid |
---|
Returns a new instance with the specified number of hours added.
This instance is immutable and unaffected by this method call.
hours | the amount of hours to add, may be negative, null means zero |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the specified number of hours added.
This instance is immutable and unaffected by this method call.
hours | the amount of hours to add, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Creates a new Hours
representing the number of complete
standard length hours in the specified period.
This factory method converts all fields from the period to hours using standardised durations for each field. Only those fields which have a precise duration in the ISO UTC chronology can be converted.
period | the period to get the number of hours from, null returns zero |
---|
IllegalArgumentException | if the period contains imprecise duration values |
---|
Converts this period in hours to a period in days assuming a 24 hour day.
This method allows you to convert between different types of period. However to achieve this it makes the assumption that all days are 24 hours long. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
Converts this period in hours to a duration in milliseconds assuming a 60 minute hour and 60 second minute.
This method allows you to convert from a period to a duration. However to achieve this it makes the assumption that all hours are 60 minutes and all minutes are 60 seconds. This might not be true for an unusual chronology, for example one that takes leap seconds into account. However, the method is included as it is a useful operation for many applications and business rules.
Converts this period in hours to a period in minutes assuming a 60 minute hour.
This method allows you to convert between different types of period. However to achieve this it makes the assumption that all hours are 60 minutes long. This may not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
ArithmeticException | if the number of minutes is too large to be represented |
---|
Converts this period in hours to a period in seconds assuming a 60 minute hour and 60 second minute.
This method allows you to convert between different types of period. However to achieve this it makes the assumption that all hours are 60 minutes long and all minutes are 60 seconds long. This may not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
ArithmeticException | if the number of seconds is too large to be represented |
---|
Converts this period in hours to a period in weeks assuming a 7 day week and 24 hour day.
This method allows you to convert between different types of period. However to achieve this it makes the assumption that all weeks are 7 days long and all days are 24 hours long. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
Gets this instance as a String in the ISO8601 duration format.
For example, "PT4H" represents 4 hours.