

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
java.lang.Object org.joda.time.base.BaseSingleFieldPeriod org.joda.time.Hours
public final class 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
typesafe 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 threadsafe and immutable.
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 

public static final Hours ZERO
public static final Hours ONE
public static final Hours TWO
public static final Hours THREE
public static final Hours FOUR
public static final Hours FIVE
public static final Hours SIX
public static final Hours SEVEN
public static final Hours EIGHT
public static final Hours MAX_VALUE
public static final Hours MIN_VALUE
Method Detail 

public static Hours hours(int hours)
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
public static Hours hoursBetween(ReadableInstant start, ReadableInstant end)
Hours
representing the number of whole hours
between the two specified datetimes.
start
 the start instant, must not be nullend
 the end instant, must not be null
IllegalArgumentException
 if the instants are null or invalidpublic static Hours hoursBetween(ReadablePartial start, ReadablePartial end)
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 nullend
 the end partial date, must not be null
IllegalArgumentException
 if the partials are null or invalidpublic static Hours hoursIn(ReadableInterval interval)
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 invalidpublic static Hours standardHoursIn(ReadablePeriod period)
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 valuespublic static Hours parseHours(String periodStr)
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 nonzero. If any other component is nonzero, an exception will be thrown.
periodStr
 the period string, null returns zero
IllegalArgumentException
 if the string format is invalidpublic DurationFieldType getFieldType()
hours
.
getFieldType
in class BaseSingleFieldPeriod
public PeriodType getPeriodType()
hours
.
getPeriodType
in interface ReadablePeriod
getPeriodType
in class BaseSingleFieldPeriod
public Weeks toStandardWeeks()
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.
public Days toStandardDays()
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.
public Minutes toStandardMinutes()
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 representedpublic Seconds toStandardSeconds()
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 representedpublic Duration toStandardDuration()
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.
public int getHours()
public Hours plus(int hours)
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 intpublic Hours plus(Hours hours)
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 intpublic Hours minus(int hours)
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 intpublic Hours minus(Hours hours)
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 intpublic Hours multipliedBy(int 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 intpublic Hours dividedBy(int divisor)
This instance is immutable and unaffected by this method call.
divisor
 the amount to divide by, may be negative
ArithmeticException
 if the divisor is zeropublic Hours negated()
ArithmeticException
 if the result overflows an intpublic boolean isGreaterThan(Hours other)
other
 the other period, null means zero
public boolean isLessThan(Hours other)
other
 the other period, null means zero
public String toString()
For example, "PT4H" represents 4 hours.
toString
in interface ReadablePeriod
toString
in class Object


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 