|
||||||||||
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.Days
public final class Days
An immutable time period representing a number of days.
Days
is an immutable period that can only store days.
It does not store years, months or hours for example. As such it is a
type-safe way of representing a number of days in an application.
The number of days is set in the constructor, and may be queried using
getDays()
. Basic mathematical operations are provided -
plus()
, minus()
, multipliedBy()
and
dividedBy()
.
Days
is thread-safe and immutable.
Field Summary | |
---|---|
static Days |
FIVE
Constant representing five days. |
static Days |
FOUR
Constant representing four days. |
static Days |
MAX_VALUE
Constant representing the maximum number of days that can be stored in this object. |
static Days |
MIN_VALUE
Constant representing the minimum number of days that can be stored in this object. |
static Days |
ONE
Constant representing one day. |
static Days |
SEVEN
Constant representing seven days. |
static Days |
SIX
Constant representing six days. |
static Days |
THREE
Constant representing three days. |
static Days |
TWO
Constant representing two days. |
static Days |
ZERO
Constant representing zero days. |
Method Summary | |
---|---|
static Days |
days(int days)
Obtains an instance of Days that may be cached. |
static Days |
daysBetween(ReadableInstant start,
ReadableInstant end)
Creates a Days representing the number of whole days
between the two specified datetimes. |
static Days |
daysBetween(ReadablePartial start,
ReadablePartial end)
Creates a Days representing the number of whole days
between the two specified partial datetimes. |
static Days |
daysIn(ReadableInterval interval)
Creates a Days representing the number of whole days
in the specified interval. |
Days |
dividedBy(int divisor)
Returns a new instance with the days divided by the specified divisor. |
int |
getDays()
Gets the number of days that this period represents. |
DurationFieldType |
getFieldType()
Gets the duration field type, which is days . |
PeriodType |
getPeriodType()
Gets the period type, which is days . |
boolean |
isGreaterThan(Days other)
Is this days instance greater than the specified number of days. |
boolean |
isLessThan(Days other)
Is this days instance less than the specified number of days. |
Days |
minus(Days days)
Returns a new instance with the specified number of days taken away. |
Days |
minus(int days)
Returns a new instance with the specified number of days taken away. |
Days |
multipliedBy(int scalar)
Returns a new instance with the days multiplied by the specified scalar. |
Days |
negated()
Returns a new instance with the days value negated. |
static Days |
parseDays(String periodStr)
Creates a new Days by parsing a string in the ISO8601 format 'PnD'. |
Days |
plus(Days days)
Returns a new instance with the specified number of days added. |
Days |
plus(int days)
Returns a new instance with the specified number of days added. |
static Days |
standardDaysIn(ReadablePeriod period)
Creates a new Days representing the number of complete
standard length days in the specified period. |
Duration |
toStandardDuration()
Converts this period in days to a duration in milliseconds assuming a 24 hour day, 60 minute hour and 60 second minute. |
Hours |
toStandardHours()
Converts this period in days to a period in hours assuming a 24 hour day. |
Minutes |
toStandardMinutes()
Converts this period in days to a period in minutes assuming a 24 hour day and 60 minute hour. |
Seconds |
toStandardSeconds()
Converts this period in days to a period in seconds assuming a 24 hour day, 60 minute hour and 60 second minute. |
Weeks |
toStandardWeeks()
Converts this period in days to a period in weeks assuming a 7 day week. |
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 Days ZERO
public static final Days ONE
public static final Days TWO
public static final Days THREE
public static final Days FOUR
public static final Days FIVE
public static final Days SIX
public static final Days SEVEN
public static final Days MAX_VALUE
public static final Days MIN_VALUE
Method Detail |
---|
public static Days days(int days)
Days
that may be cached.
Days
is immutable, so instances can be cached and shared.
This factory method provides access to shared instances.
days
- the number of days to obtain an instance for
public static Days daysBetween(ReadableInstant start, ReadableInstant end)
Days
representing the number of whole days
between the two specified datetimes. This method corectly handles
any daylight savings time changes that may occur during the interval.
start
- the start instant, must not be nullend
- the end instant, must not be null
IllegalArgumentException
- if the instants are null or invalidpublic static Days daysBetween(ReadablePartial start, ReadablePartial end)
Days
representing the number of whole days
between the two specified partial datetimes.
The two partials must contain the same fields, for example you can specify
two LocalDate
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 Days daysIn(ReadableInterval interval)
Days
representing the number of whole days
in the specified interval. This method corectly handles any daylight
savings time changes that may occur during the interval.
interval
- the interval to extract days from, null returns zero
IllegalArgumentException
- if the partials are null or invalidpublic static Days standardDaysIn(ReadablePeriod period)
Days
representing the number of complete
standard length days 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 Days parseDays(String periodStr)
Days
by parsing a string in the ISO8601 format 'PnD'.
The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the days 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 invalidpublic DurationFieldType getFieldType()
days
.
getFieldType
in class BaseSingleFieldPeriod
public PeriodType getPeriodType()
days
.
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. 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.
public Hours toStandardHours()
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 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.
ArithmeticException
- if the number of hours is too large to be representedpublic Minutes toStandardMinutes()
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 and all hours are 60 minutes long. This is not true when daylight savings 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.
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 days are 24 hours long, all hours are 60 minutes long and all minutes are 60 seconds long. This is not true when daylight savings 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.
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 days are 24 hours long, all hours are 60 minutes and all minutes are 60 seconds. 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 int getDays()
public Days plus(int days)
This instance is immutable and unaffected by this method call.
days
- the amount of days to add, may be negative
ArithmeticException
- if the result overflows an intpublic Days plus(Days days)
This instance is immutable and unaffected by this method call.
days
- the amount of days to add, may be negative, null means zero
ArithmeticException
- if the result overflows an intpublic Days minus(int days)
This instance is immutable and unaffected by this method call.
days
- the amount of days to take away, may be negative
ArithmeticException
- if the result overflows an intpublic Days minus(Days days)
This instance is immutable and unaffected by this method call.
days
- the amount of days to take away, may be negative, null means zero
ArithmeticException
- if the result overflows an intpublic Days 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 Days 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 Days negated()
ArithmeticException
- if the result overflows an intpublic boolean isGreaterThan(Days other)
other
- the other period, null means zero
public boolean isLessThan(Days other)
other
- the other period, null means zero
public String toString()
For example, "P4D" represents 4 days.
toString
in interface ReadablePeriod
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |