Class Hours
- All Implemented Interfaces:
Serializable
,Comparable<BaseSingleFieldPeriod>
,ReadablePeriod
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.
- Since:
- 1.4
- Author:
- Stephen Colebourne
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Hours
Constant representing eight hours.static final Hours
Constant representing five hours.static final Hours
Constant representing four hours.static final Hours
Constant representing the maximum number of hours that can be stored in this object.static final Hours
Constant representing the minimum number of hours that can be stored in this object.static final Hours
Constant representing one hour.static final Hours
Constant representing seven hours.static final Hours
Constant representing six hours.static final Hours
Constant representing three hours.static final Hours
Constant representing two hours.static final Hours
Constant representing zero hours. -
Method Summary
Modifier and TypeMethodDescriptiondividedBy
(int divisor) Returns a new instance with the hours divided by the specified divisor.Gets the duration field type, which ishours
.int
getHours()
Gets the number of hours that this period represents.Gets the period type, which ishours
.static Hours
hours
(int hours) Obtains an instance ofHours
that may be cached.static Hours
hoursBetween
(ReadableInstant start, ReadableInstant end) Creates aHours
representing the number of whole hours between the two specified datetimes.static Hours
hoursBetween
(ReadablePartial start, ReadablePartial end) Creates aHours
representing the number of whole hours between the two specified partial datetimes.static Hours
hoursIn
(ReadableInterval interval) Creates aHours
representing the number of whole hours in the specified interval.boolean
isGreaterThan
(Hours other) Is this hours instance greater than the specified number of hours.boolean
isLessThan
(Hours other) Is this hours instance less than the specified number of hours.minus
(int 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.multipliedBy
(int scalar) Returns a new instance with the hours multiplied by the specified scalar.negated()
Returns a new instance with the hours value negated.static Hours
parseHours
(String periodStr) Creates a newHours
by parsing a string in the ISO8601 format 'PTnH'.plus
(int hours) Returns a new instance with the specified number of hours added.Returns a new instance with the specified number of hours added.static Hours
standardHoursIn
(ReadablePeriod period) Creates a newHours
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.toString()
Gets this instance as a String in the ISO8601 duration format.Methods inherited from class org.joda.time.base.BaseSingleFieldPeriod
between, between, compareTo, equals, get, getFieldType, getValue, getValue, hashCode, isSupported, setValue, size, standardPeriodIn, toMutablePeriod, toPeriod
-
Field Details
-
ZERO
Constant representing zero hours. -
ONE
Constant representing one hour. -
TWO
Constant representing two hours. -
THREE
Constant representing three hours. -
FOUR
Constant representing four hours. -
FIVE
Constant representing five hours. -
SIX
Constant representing six hours. -
SEVEN
Constant representing seven hours. -
EIGHT
Constant representing eight 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.
-
-
Method Details
-
hours
Obtains an instance ofHours
that may be cached.Hours
is immutable, so instances can be cached and shared. This factory method provides access to shared instances.- Parameters:
hours
- the number of hours to obtain an instance for- Returns:
- the instance of Hours
-
hoursBetween
Creates aHours
representing the number of whole hours between the two specified datetimes.- Parameters:
start
- the start instant, must not be nullend
- the end instant, must not be null- Returns:
- the period in hours
- Throws:
IllegalArgumentException
- if the instants are null or invalid
-
hoursBetween
Creates aHours
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.- Parameters:
start
- the start partial date, must not be nullend
- the end partial date, must not be null- Returns:
- the period in hours
- Throws:
IllegalArgumentException
- if the partials are null or invalid
-
hoursIn
Creates aHours
representing the number of whole hours in the specified interval.- Parameters:
interval
- the interval to extract hours from, null returns zero- Returns:
- the period in hours
- Throws:
IllegalArgumentException
- if the partials are null or invalid
-
standardHoursIn
Creates a newHours
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.
- One week consists of 7 days.
- One day consists of 24 hours.
- One hour consists of 60 minutes.
- One minute consists of 60 seconds.
- One second consists of 1000 milliseconds.
- Parameters:
period
- the period to get the number of hours from, null returns zero- Returns:
- the period in hours
- Throws:
IllegalArgumentException
- if the period contains imprecise duration values
-
parseHours
Creates a newHours
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.
- Parameters:
periodStr
- the period string, null returns zero- Returns:
- the period in hours
- Throws:
IllegalArgumentException
- if the string format is invalid
-
getFieldType
Gets the duration field type, which ishours
.- Specified by:
getFieldType
in classBaseSingleFieldPeriod
- Returns:
- the period type
-
getPeriodType
Gets the period type, which ishours
.- Specified by:
getPeriodType
in interfaceReadablePeriod
- Specified by:
getPeriodType
in classBaseSingleFieldPeriod
- Returns:
- the period type
-
toStandardWeeks
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.
- Returns:
- a period representing the number of whole weeks for this number of hours
-
toStandardDays
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.
- Returns:
- a period representing the number of whole days for this number of hours
-
toStandardMinutes
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.
- Returns:
- a period representing the number of minutes for this number of hours
- Throws:
ArithmeticException
- if the number of minutes is too large to be represented
-
toStandardSeconds
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.
- Returns:
- a period representing the number of seconds for this number of hours
- Throws:
ArithmeticException
- if the number of seconds is too large to be represented
-
toStandardDuration
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.
- Returns:
- a duration equivalent to this number of hours
-
getHours
public int getHours()Gets the number of hours that this period represents.- Returns:
- the number of hours in the period
-
plus
Returns a new instance with the specified number of hours added.This instance is immutable and unaffected by this method call.
- Parameters:
hours
- the amount of hours to add, may be negative- Returns:
- the new period plus the specified number of hours
- Throws:
ArithmeticException
- if the result overflows an int
-
plus
Returns a new instance with the specified number of hours added.This instance is immutable and unaffected by this method call.
- Parameters:
hours
- the amount of hours to add, may be negative, null means zero- Returns:
- the new period plus the specified number of hours
- Throws:
ArithmeticException
- if the result overflows an int
-
minus
Returns a new instance with the specified number of hours taken away.This instance is immutable and unaffected by this method call.
- Parameters:
hours
- the amount of hours to take away, may be negative- Returns:
- the new period minus the specified number of hours
- Throws:
ArithmeticException
- if the result overflows an int
-
minus
Returns a new instance with the specified number of hours taken away.This instance is immutable and unaffected by this method call.
- Parameters:
hours
- the amount of hours to take away, may be negative, null means zero- Returns:
- the new period minus the specified number of hours
- Throws:
ArithmeticException
- if the result overflows an int
-
multipliedBy
Returns a new instance with the hours multiplied by the specified scalar.This instance is immutable and unaffected by this method call.
- Parameters:
scalar
- the amount to multiply by, may be negative- Returns:
- the new period multiplied by the specified scalar
- Throws:
ArithmeticException
- if the result overflows an int
-
dividedBy
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.
- Parameters:
divisor
- the amount to divide by, may be negative- Returns:
- the new period divided by the specified divisor
- Throws:
ArithmeticException
- if the divisor is zero
-
negated
Returns a new instance with the hours value negated.- Returns:
- the new period with a negated value
- Throws:
ArithmeticException
- if the result overflows an int
-
isGreaterThan
Is this hours instance greater than the specified number of hours.- Parameters:
other
- the other period, null means zero- Returns:
- true if this hours instance is greater than the specified one
-
isLessThan
Is this hours instance less than the specified number of hours.- Parameters:
other
- the other period, null means zero- Returns:
- true if this hours instance is less than the specified one
-
toString
Gets this instance as a String in the ISO8601 duration format.For example, "PT4H" represents 4 hours.
- Specified by:
toString
in interfaceReadablePeriod
- Overrides:
toString
in classObject
- Returns:
- the value as an ISO8601 string
-