java.lang.Object | ||
↳ | org.joda.time.base.BaseSingleFieldPeriod | |
↳ | org.joda.time.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.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
FIVE | Constant representing five days. | ||||||||||
FOUR | Constant representing four days. | ||||||||||
MAX_VALUE | Constant representing the maximum number of days that can be stored in this object. | ||||||||||
MIN_VALUE | Constant representing the minimum number of days that can be stored in this object. | ||||||||||
ONE | Constant representing one day. | ||||||||||
SEVEN | Constant representing seven days. | ||||||||||
SIX | Constant representing six days. | ||||||||||
THREE | Constant representing three days. | ||||||||||
TWO | Constant representing two days. | ||||||||||
ZERO | Constant representing zero days. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Obtains an instance of
Days that may be cached. | |||||||||||
Creates a
Days representing the number of whole days
between the two specified partial datetimes. | |||||||||||
Creates a
Days representing the number of whole days
between the two specified datetimes. | |||||||||||
Creates a
Days representing the number of whole days
in the specified interval. | |||||||||||
Returns a new instance with the days divided by the specified divisor.
| |||||||||||
Gets the number of days that this period represents.
| |||||||||||
Gets the duration field type, which is
days . | |||||||||||
Gets the period type, which is
days . | |||||||||||
Is this days instance greater than the specified number of days.
| |||||||||||
Is this days instance less than the specified number of days.
| |||||||||||
Returns a new instance with the specified number of days taken away.
| |||||||||||
Returns a new instance with the specified number of days taken away.
| |||||||||||
Returns a new instance with the days multiplied by the specified scalar.
| |||||||||||
Returns a new instance with the days value negated.
| |||||||||||
Creates a new
Days by parsing a string in the ISO8601 format 'PnD'. | |||||||||||
Returns a new instance with the specified number of days added.
| |||||||||||
Returns a new instance with the specified number of days added.
| |||||||||||
Creates a new
Days representing the number of complete
standard length days in the specified period. | |||||||||||
Converts this period in days to a duration in milliseconds assuming a
24 hour day, 60 minute hour and 60 second minute.
| |||||||||||
Converts this period in days to a period in hours assuming a
24 hour day.
| |||||||||||
Converts this period in days to a period in minutes assuming a
24 hour day and 60 minute hour.
| |||||||||||
Converts this period in days to a period in seconds assuming a
24 hour day, 60 minute hour and 60 second minute.
| |||||||||||
Converts this period in days to a period in weeks assuming a
7 day week.
| |||||||||||
Gets this instance as a String in the ISO8601 duration format.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.joda.time.base.BaseSingleFieldPeriod
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
| |||||||||||
From interface
org.joda.time.ReadablePeriod
|
Constant representing the maximum number of days that can be stored in this object.
Constant representing the minimum number of days that can be stored in this object.
Obtains an instance of 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 |
---|
Creates a 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 null |
---|---|
end | the end partial date, must not be null |
IllegalArgumentException | if the partials are null or invalid |
---|
Creates a 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 null |
---|---|
end | the end instant, must not be null |
IllegalArgumentException | if the instants are null or invalid |
---|
Creates a 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 invalid |
---|
Returns a new instance with the days 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.
divisor | the amount to divide by, may be negative |
---|
ArithmeticException | if the divisor is zero |
---|
Gets the number of days that this period represents.
Gets the duration field type, which is days
.
Is this days instance greater than the specified number of days.
other | the other period, null means zero |
---|
Is this days instance less than the specified number of days.
other | the other period, null means zero |
---|
Returns a new instance with the specified number of days taken away.
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 int |
---|
Returns a new instance with the specified number of days taken away.
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 int |
---|
Returns a new instance with the days multiplied by the specified 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 int |
---|
Returns a new instance with the days value negated.
ArithmeticException | if the result overflows an int |
---|
Creates a new 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 invalid |
---|
Returns a new instance with the specified number of days added.
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 int |
---|
Returns a new instance with the specified number of days added.
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 int |
---|
Creates a new 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 values |
---|
Converts this period in days to a duration in milliseconds assuming a 24 hour day, 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 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.
Converts this period in days to a period in hours 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 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 represented |
---|
Converts this period in days to a period in minutes assuming a 24 hour day and 60 minute hour.
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 represented |
---|
Converts this period in days to a period in seconds assuming a 24 hour day, 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 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 represented |
---|
Converts this period in days to a period in weeks assuming a 7 day week.
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.
Gets this instance as a String in the ISO8601 duration format.
For example, "P4D" represents 4 days.