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