This class models a quantity or amount of time in terms of days. It is a type-safe way of representing a number of days in an application.
The model is of a directed amount, meaning that the amount may be negative.
This class must be treated as a value type. Do not synchronize, rely on the identity hash code or use the distinction between equals() and ==.
| Modifier and Type | Field and Description |
|---|---|
| private final int | days
The number of days. |
| private static final int | DAYS_PER_WEEK
The number of days per week. |
| public static final Days | ONE
A constant for one day. |
| private static final Pattern | PATTERN
The pattern for parsing. |
| private static final long | serialVersionUID
A serialization identifier for this class. |
| public static final Days | ZERO
A constant for zero days. |
| Access | Constructor and Description |
|---|---|
| private |
| Modifier and Type | Method and Description |
|---|---|
| public Days | |
| public Temporal | Returns: an object of the same type with the adjustment made, not nullthe temporal object to adjust, not null temporal)Implements java. Adds this amount to the specified temporal object. |
| public static Days | |
| public int | Returns: the comparator value, negative if less, positive if greaterthe other amount, not null otherAmount)Implements java. Compares this amount to the specified |
| public Days | Returns: the amount divided by the specified divisor, not nullthe amount to divide by, may be negative divisor)Returns an instance with the amount divided by the specified divisor. |
| public boolean | Returns: true if the other amount is equal to this onethe other amount, null returns false otherAmount)Overrides java. Checks if this amount is equal to the specified |
| public static Days | Returns: the equivalent amount, not nullthe temporal amount to convert, not null amount)Obtains an instance of |
| public long | Returns: the long value of the unitthe unit)TemporalUnit for which to return the valueImplements java. Gets the value of the requested unit. |
| public int | |
| public List | Returns: a list containing the days unit, not nullImplements java. Gets the set of units supported by this amount. |
| public int | Returns: a suitable hash codeOverrides java. A hash code for this amount. |
| public boolean | Returns: true if the amount is negative, false if the amount is zero or positiveChecks if the amount is negative. |
| public boolean | Returns: true if the amount is positive, false if the amount is zero or negativeChecks if the amount is positive. |
| public boolean | |
| public Days | Returns: aDays based on this instance with the requested amount subtracted, not nullthe amount to subtract, not null amountToSubtract)Returns a copy of this amount with the specified amount subtracted. |
| public Days | Returns: aDays based on this instance with the requested amount subtracted, not nullthe amount of days to add, may be negative days)Returns a copy of this amount with the specified number of days subtracted. |
| public Days | Returns: the amount multiplied by the specified scalar, not nullthe scalar to multiply by, not null scalar)Returns an instance with the amount multiplied by the specified scalar. |
| public Days | |
| public static Days | Returns: the number of days, not nullthe number of days, positive or negative days)Obtains a |
| public static Days | Returns: the amount with the input weeks converted to days, not nullthe number of weeks, positive or negative weeks)Obtains a |
| public static Days | Returns: the parsed period, not nullthe text to parse, not null text)Obtains a |
| public Days | Returns: aDays based on this instance with the requested amount added, not nullthe amount to add, not null amountToAdd)Returns a copy of this amount with the specified amount added. |
| public Days | Returns: aDays based on this instance with the requested amount added, not nullthe amount of days to add, may be negative days)Returns a copy of this amount with the specified number of days added. |
| private Object | |
| public Temporal | Returns: an object of the same type with the adjustment made, not nullthe temporal object to adjust, not null temporal)Implements java. Subtracts this amount from the specified temporal object. |
| public Period | |
| public String | Returns: the number of days in ISO-8601 string formatOverrides java. Returns a string representation of the number of days. |
| days | back to summary |
|---|---|
| private final int days The number of days. | |
| DAYS_PER_WEEK | back to summary |
|---|---|
| private static final int DAYS_PER_WEEK The number of days per week. | |
| ONE | back to summary |
|---|---|
| public static final Days ONE A constant for one day. | |
| PATTERN | back to summary |
|---|---|
| private static final Pattern PATTERN The pattern for parsing. | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID A serialization identifier for this class. | |
| ZERO | back to summary |
|---|---|
| public static final Days ZERO A constant for zero days. | |
| Days | back to summary |
|---|---|
| private Days(int days) Constructs an instance using a specific number of days.
| |
| abs | back to summary |
|---|---|
| public Days abs() Returns a copy of this duration with a positive length. This method returns a positive duration by effectively removing the sign from any negative total length. This instance is immutable and unaffected by this method call.
| |
| addTo | back to summary |
|---|---|
| public Temporal addTo(Temporal temporal) Implements java. Adds this amount to the specified temporal object. This returns a temporal object of the same observable type as the input with this amount added.
In most cases, it is clearer to reverse the calling pattern by using
// these two lines are equivalent, but the second approach is recommended dateTime = thisAmount.addTo(dateTime); dateTime = dateTime.plus(thisAmount); Only non-zero amounts will be added. This instance is immutable and unaffected by this method call.
| |
| between | back to summary |
|---|---|
| public static Days between(Temporal startDateInclusive, Temporal endDateExclusive) Obtains a The start date is included, but the end date is not. The result of this method can be negative if the end is before the start. | |
| compareTo | back to summary |
|---|---|
| public int compareTo(Days otherAmount) Implements java. Compares this amount to the specified
The comparison is based on the total length of the amounts.
It is "consistent with equals", as defined by | |
| dividedBy | back to summary |
|---|---|
| public Days dividedBy(int divisor) Returns an instance with the amount 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.
| |
| equals | back to summary |
|---|---|
| public boolean equals(Object otherAmount) Overrides java. Checks if this amount is equal to the specified The comparison is based on the total length of the durations. | |
| from | back to summary |
|---|---|
| public static Days from(TemporalAmount amount) Obtains an instance of
This obtains an instance based on the specified amount.
A
The result is calculated by looping around each unit in the specified amount.
Each amount is converted to days using
| |
| get | back to summary |
|---|---|
| public long get(TemporalUnit unit) Implements java. Gets the value of the requested unit.
This returns a value for the supported unit -
| |
| getAmount | back to summary |
|---|---|
| public int getAmount() Gets the number of days in this amount.
| |
| getUnits | back to summary |
|---|---|
| public List Implements java. Gets the set of units supported by this amount.
The single supported unit is
This set can be used in conjunction with
| |
| hashCode | back to summary |
|---|---|
| public int hashCode() Overrides java. A hash code for this amount.
| |
| isNegative | back to summary |
|---|---|
| public boolean isNegative() Checks if the amount is negative.
| |
| isPositive | back to summary |
|---|---|
| public boolean isPositive() Checks if the amount is positive.
| |
| isZero | back to summary |
|---|---|
| public boolean isZero() Checks if the amount is zero.
| |
| minus | back to summary |
|---|---|
| public Days minus(TemporalAmount amountToSubtract) Returns a copy of this amount with the specified amount subtracted.
The parameter is converted using This instance is immutable and unaffected by this method call.
| |
| minus | back to summary |
|---|---|
| public Days minus(int days) Returns a copy of this amount with the specified number of days subtracted. This instance is immutable and unaffected by this method call.
| |
| multipliedBy | back to summary |
|---|---|
| public Days multipliedBy(int scalar) Returns an instance with the amount multiplied by the specified scalar. This instance is immutable and unaffected by this method call.
| |
| negated | back to summary |
|---|---|
| public Days negated() Returns an instance with the amount negated. This instance is immutable and unaffected by this method call.
| |
| of | back to summary |
|---|---|
| public static Days of(int days) Obtains a The resulting amount will have the specified days.
| |
| ofWeeks | back to summary |
|---|---|
| public static Days ofWeeks(int weeks) Obtains a The resulting amount will be day-based, with the number of days equal to the number of weeks multiplied by 7.
| |
| parse | back to summary |
|---|---|
| public static Days parse(CharSequence text) Obtains a
This will parse the string produced by
The string starts with an optional sign, denoted by the ASCII negative
or positive symbol. If negative, the whole amount is negated.
The ASCII letter "P" is next in upper or lower case.
There are then two sections, each consisting of a number and a suffix.
At least one of the two sections must be present.
The sections have suffixes in ASCII of "W" and "D" for weeks and days,
accepted in upper or lower case. The suffixes must occur in order.
The number part of each section must consist of ASCII digits.
The number may be prefixed by the ASCII negative or positive symbol.
The number must parse to an The leading plus/minus sign, and negative values for weeks and days are not part of the ISO-8601 standard. For example, the following are valid inputs: "P2D" -- Days.of(2) "P-2D" -- Days.of(-2) "-P2D" -- Days.of(-2) "-P-2D" -- Days.of(2) "P3W" -- Days.of(3 * 7) "P3W-2D" -- Days.of(3 * 7 - 2)
| |
| plus | back to summary |
|---|---|
| public Days plus(TemporalAmount amountToAdd) Returns a copy of this amount with the specified amount added.
The parameter is converted using This instance is immutable and unaffected by this method call.
| |
| plus | back to summary |
|---|---|
| public Days plus(int days) Returns a copy of this amount with the specified number of days added. This instance is immutable and unaffected by this method call.
| |
| readResolve | back to summary |
|---|---|
| private Object readResolve() Resolves singletons.
| |
| subtractFrom | back to summary |
|---|---|
| public Temporal subtractFrom(Temporal temporal) Implements java. Subtracts this amount from the specified temporal object. This returns a temporal object of the same observable type as the input with this amount subtracted.
In most cases, it is clearer to reverse the calling pattern by using
// these two lines are equivalent, but the second approach is recommended dateTime = thisAmount.subtractFrom(dateTime); dateTime = dateTime.minus(thisAmount); Only non-zero amounts will be subtracted. This instance is immutable and unaffected by this method call.
| |
| toPeriod | back to summary |
|---|---|
| public Period toPeriod() Gets the number of days as a This returns a period with the same number of days.
| |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Returns a string representation of the number of days. This will be in the format 'PnD' where n is the number of days. | |