org.joda.time
Class Hours

java.lang.Object
  extended by org.joda.time.base.BaseSingleFieldPeriod
      extended by org.joda.time.Hours
All Implemented Interfaces:
Serializable, Comparable<BaseSingleFieldPeriod>, ReadablePeriod

public final class Hours
extends BaseSingleFieldPeriod

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.

Since:
1.4
Author:
Stephen Colebourne
See Also:
Serialized Form

Field Summary
static Hours EIGHT
          Constant representing eight hours.
static Hours FIVE
          Constant representing five hours.
static Hours FOUR
          Constant representing four hours.
static Hours MAX_VALUE
          Constant representing the maximum number of hours that can be stored in this object.
static Hours MIN_VALUE
          Constant representing the minimum number of hours that can be stored in this object.
static Hours ONE
          Constant representing one hour.
static Hours SEVEN
          Constant representing seven hours.
static Hours SIX
          Constant representing six hours.
static Hours THREE
          Constant representing three hours.
static Hours TWO
          Constant representing two hours.
static Hours ZERO
          Constant representing zero hours.
 
Method Summary
 Hours dividedBy(int divisor)
          Returns a new instance with the hours divided by the specified divisor.
 DurationFieldType getFieldType()
          Gets the duration field type, which is hours.
 int getHours()
          Gets the number of hours that this period represents.
 PeriodType getPeriodType()
          Gets the period type, which is hours.
static Hours hours(int hours)
          Obtains an instance of Hours that may be cached.
static Hours hoursBetween(ReadableInstant start, ReadableInstant end)
          Creates a Hours representing the number of whole hours between the two specified datetimes.
static Hours hoursBetween(ReadablePartial start, ReadablePartial end)
          Creates a Hours representing the number of whole hours between the two specified partial datetimes.
static Hours hoursIn(ReadableInterval interval)
          Creates a Hours 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.
 Hours minus(Hours hours)
          Returns a new instance with the specified number of hours taken away.
 Hours minus(int hours)
          Returns a new instance with the specified number of hours taken away.
 Hours multipliedBy(int scalar)
          Returns a new instance with the hours multiplied by the specified scalar.
 Hours negated()
          Returns a new instance with the hours value negated.
static Hours parseHours(String periodStr)
          Creates a new Hours by parsing a string in the ISO8601 format 'PTnH'.
 Hours plus(Hours hours)
          Returns a new instance with the specified number of hours added.
 Hours plus(int hours)
          Returns a new instance with the specified number of hours added.
static Hours standardHoursIn(ReadablePeriod period)
          Creates a new Hours representing the number of complete standard length hours in the specified period.
 Days toStandardDays()
          Converts this period in hours to a period in days assuming a 24 hour day.
 Duration toStandardDuration()
          Converts this period in hours to a duration in milliseconds assuming a 60 minute hour and 60 second minute.
 Minutes toStandardMinutes()
          Converts this period in hours to a period in minutes assuming a 60 minute hour.
 Seconds toStandardSeconds()
          Converts this period in hours to a period in seconds assuming a 60 minute hour and 60 second minute.
 Weeks toStandardWeeks()
          Converts this period in hours to a period in weeks assuming a 7 day week and 24 hour day.
 String 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
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ZERO

public static final Hours ZERO
Constant representing zero hours.


ONE

public static final Hours ONE
Constant representing one hour.


TWO

public static final Hours TWO
Constant representing two hours.


THREE

public static final Hours THREE
Constant representing three hours.


FOUR

public static final Hours FOUR
Constant representing four hours.


FIVE

public static final Hours FIVE
Constant representing five hours.


SIX

public static final Hours SIX
Constant representing six hours.


SEVEN

public static final Hours SEVEN
Constant representing seven hours.


EIGHT

public static final Hours EIGHT
Constant representing eight hours.


MAX_VALUE

public static final Hours MAX_VALUE
Constant representing the maximum number of hours that can be stored in this object.


MIN_VALUE

public static final Hours MIN_VALUE
Constant representing the minimum number of hours that can be stored in this object.

Method Detail

hours

public static Hours hours(int hours)
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
Returns:
the instance of Hours

hoursBetween

public static Hours hoursBetween(ReadableInstant start,
                                 ReadableInstant end)
Creates a Hours representing the number of whole hours between the two specified datetimes.

Parameters:
start - the start instant, must not be null
end - the end instant, must not be null
Returns:
the period in hours
Throws:
IllegalArgumentException - if the instants are null or invalid

hoursBetween

public static Hours hoursBetween(ReadablePartial start,
                                 ReadablePartial end)
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
end - the end partial date, must not be null
Returns:
the period in hours
Throws:
IllegalArgumentException - if the partials are null or invalid

hoursIn

public static Hours hoursIn(ReadableInterval interval)
Creates a Hours 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

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. Only those fields which have a precise duration in the ISO UTC chronology can be converted.

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
Returns:
the period in hours
Throws:
IllegalArgumentException - if the period contains imprecise duration values

parseHours

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. 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

public DurationFieldType getFieldType()
Gets the duration field type, which is hours.

Specified by:
getFieldType in class BaseSingleFieldPeriod
Returns:
the period type

getPeriodType

public PeriodType getPeriodType()
Gets the period type, which is hours.

Specified by:
getPeriodType in interface ReadablePeriod
Specified by:
getPeriodType in class BaseSingleFieldPeriod
Returns:
the period type

toStandardWeeks

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. 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

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. 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

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. 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

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. 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

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. 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

public Hours plus(int hours)
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

public Hours plus(Hours hours)
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

public Hours minus(int hours)
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

public Hours minus(Hours hours)
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

public Hours multipliedBy(int scalar)
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

public Hours dividedBy(int divisor)
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

public Hours 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

public boolean isGreaterThan(Hours other)
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

public boolean isLessThan(Hours other)
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

public String toString()
Gets this instance as a String in the ISO8601 duration format.

For example, "PT4H" represents 4 hours.

Specified by:
toString in interface ReadablePeriod
Overrides:
toString in class Object
Returns:
the value as an ISO8601 string


Copyright © 2002-2013 Joda.org. All Rights Reserved.