| java.lang.Object
 org.joda.time.base.BaseSingleFieldPeriod
org.joda.time.Hours
| Hours | | final public class Hours extends BaseSingleFieldPeriod (Code) | | 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.
author:
Stephen Colebourne
since:
1.4 |
| Field Summary | |
| final public static Hours | EIGHT
Constant representing eight hours. | | final public static Hours | FIVE
Constant representing five hours. | | final public static Hours | FOUR
Constant representing four hours. | | final public static Hours | MAX_VALUE
Constant representing the maximum number of hours that can be stored in this object. | | final public static Hours | MIN_VALUE
Constant representing the minimum number of hours that can be stored in this object. | | final public static Hours | ONE
Constant representing one hour. | | final public static Hours | SEVEN
Constant representing seven hours. | | final public static Hours | SIX
Constant representing six hours. | | final public static Hours | THREE
Constant representing three hours. | | final public static Hours | TWO
Constant representing two hours. | | final public static Hours | ZERO
Constant representing zero hours. |
| Method Summary | |
| public Hours | dividedBy(int divisor)
Returns a new instance with the hours divided by the specified divisor. | | public DurationFieldType | getFieldType()
Gets the duration field type, which is hours. | | public int | getHours()
Gets the number of hours that this period represents. | | public PeriodType | getPeriodType()
Gets the period type, which is hours. | | public static Hours | hours(int hours)
Obtains an instance of Hours that may be cached. | | public static Hours | hoursBetween(ReadableInstant start, ReadableInstant end)
Creates a Hours representing the number of whole hours
between the two specified datetimes. | | public static Hours | hoursBetween(ReadablePartial start, ReadablePartial end)
Creates a Hours representing the number of whole hours
between the two specified partial datetimes. | | public static Hours | hoursIn(ReadableInterval interval)
Creates a Hours representing the number of whole hours
in the specified interval. | | public boolean | isGreaterThan(Hours other)
Is this hours instance greater than the specified number of hours. | | public boolean | isLessThan(Hours other)
Is this hours instance less than the specified number of hours. | | public Hours | minus(int hours)
Returns a new instance with the specified number of hours taken away. | | public Hours | minus(Hours hours)
Returns a new instance with the specified number of hours taken away. | | public Hours | multipliedBy(int scalar)
Returns a new instance with the hours multiplied by the specified scalar. | | public Hours | negated()
Returns a new instance with the hours value negated. | | public static Hours | parseHours(String periodStr)
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. | | public Hours | plus(int hours)
Returns a new instance with the specified number of hours added. | | public Hours | plus(Hours hours)
Returns a new instance with the specified number of hours added. | | public static Hours | standardHoursIn(ReadablePeriod period)
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. | | public Days | 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. | | public Duration | 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. | | public Minutes | 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. | | public Seconds | 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. | | public Weeks | 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. | | public String | toString()
Gets this instance as a String in the ISO8601 duration format. |
| EIGHT | | final public static Hours EIGHT(Code) | | Constant representing eight hours.
|
| FIVE | | final public static Hours FIVE(Code) | | Constant representing five hours.
|
| FOUR | | final public static Hours FOUR(Code) | | Constant representing four hours.
|
| MAX_VALUE | | final public static Hours MAX_VALUE(Code) | | Constant representing the maximum number of hours that can be stored in this object.
|
| MIN_VALUE | | final public static Hours MIN_VALUE(Code) | | Constant representing the minimum number of hours that can be stored in this object.
|
| ONE | | final public static Hours ONE(Code) | | Constant representing one hour.
|
| SEVEN | | final public static Hours SEVEN(Code) | | Constant representing seven hours.
|
| SIX | | final public static Hours SIX(Code) | | Constant representing six hours.
|
| THREE | | final public static Hours THREE(Code) | | Constant representing three hours.
|
| TWO | | final public static Hours TWO(Code) | | Constant representing two hours.
|
| ZERO | | final public static Hours ZERO(Code) | | Constant representing zero hours.
|
| dividedBy | | public Hours dividedBy(int divisor)(Code) | | 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 the new period divided by the specified divisor
throws:
ArithmeticException - if the divisor is zero |
| getFieldType | | public DurationFieldType getFieldType()(Code) | | Gets the duration field type, which is hours.
the period type |
| getHours | | public int getHours()(Code) | | Gets the number of hours that this period represents.
the number of hours in the period |
| getPeriodType | | public PeriodType getPeriodType()(Code) | | Gets the period type, which is hours.
the period type |
| hours | | public static Hours hours(int hours)(Code) | | 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.
Parameters:
hours - the number of hours to obtain an instance for the instance of Hours |
| hoursBetween | | public static Hours hoursBetween(ReadableInstant start, ReadableInstant end)(Code) | | Creates a Hours representing the number of whole hours
between the two specified datetimes.
Parameters:
start - the start instant, must not be null
Parameters:
end - the end instant, must not be null the period in hours
throws:
IllegalArgumentException - if the instants are null or invalid |
| hoursBetween | | public static Hours hoursBetween(ReadablePartial start, ReadablePartial end)(Code) | | 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.
Parameters:
start - the start partial date, must not be null
Parameters:
end - the end partial date, must not be null the period in hours
throws:
IllegalArgumentException - if the partials are null or invalid |
| hoursIn | | public static Hours hoursIn(ReadableInterval interval)(Code) | | Creates a Hours representing the number of whole hours
in the specified interval.
Parameters:
interval - the interval to extract hours from, null returns zero the period in hours
throws:
IllegalArgumentException - if the partials are null or invalid |
| isGreaterThan | | public boolean isGreaterThan(Hours other)(Code) | | Is this hours instance greater than the specified number of hours.
Parameters:
other - the other period, null means zero true if this hours instance is greater than the specified one |
| isLessThan | | public boolean isLessThan(Hours other)(Code) | | Is this hours instance less than the specified number of hours.
Parameters:
other - the other period, null means zero true if this hours instance is less than the specified one |
| minus | | public Hours minus(int hours)(Code) | | 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 the new period minus the specified number of hours
throws:
ArithmeticException - if the result overflows an int |
| minus | | public Hours minus(Hours hours)(Code) | | 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 the new period minus the specified number of hours
throws:
ArithmeticException - if the result overflows an int |
| multipliedBy | | public Hours multipliedBy(int scalar)(Code) | | 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 the new period multiplied by the specified scalar
throws:
ArithmeticException - if the result overflows an int |
| negated | | public Hours negated()(Code) | | Returns a new instance with the hours value negated.
the new period with a negated value
throws:
ArithmeticException - if the result overflows an int |
| parseHours | | public static Hours parseHours(String periodStr)(Code) | | 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.
Parameters:
periodStr - the period string, null returns zero the period in hours
throws:
IllegalArgumentException - if the string format is invalid |
| plus | | public Hours plus(int hours)(Code) | | 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 the new period plus the specified number of hours
throws:
ArithmeticException - if the result overflows an int |
| plus | | public Hours plus(Hours hours)(Code) | | 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 the new period plus the specified number of hours
throws:
ArithmeticException - if the result overflows an int |
| standardHoursIn | | public static Hours standardHoursIn(ReadablePeriod period)(Code) | | 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.
- 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.
Months and Years are imprecise and periods containing these values cannot be converted.
Parameters:
period - the period to get the number of hours from, null returns zero the period in hours
throws:
IllegalArgumentException - if the period contains imprecise duration values |
| toStandardDays | | public Days toStandardDays()(Code) | | 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.
a period representing the number of whole days for this number of hours |
| toStandardDuration | | public Duration toStandardDuration()(Code) | | 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.
a duration equivalent to this number of hours |
| toStandardMinutes | | public Minutes toStandardMinutes()(Code) | | 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.
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 | | public Seconds toStandardSeconds()(Code) | | 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.
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 |
| toStandardWeeks | | public Weeks toStandardWeeks()(Code) | | 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.
a period representing the number of whole weeks for this number of hours |
| toString | | public String toString()(Code) | | Gets this instance as a String in the ISO8601 duration format.
For example, "PT4H" represents 4 hours.
the value as an ISO8601 string |
|
|