 java.lang.Object

 org.threeten.extra.Days

 All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<Days>
,java.time.temporal.TemporalAmount
public final class Days extends java.lang.Object implements java.time.temporal.TemporalAmount, java.lang.Comparable<Days>, java.io.Serializable
A daybased amount of time, such as '12 days'.This class models a quantity or amount of time in terms of days. It is a typesafe way of representing a number of days in an application.
The model is of a directed amount, meaning that the amount may be negative.
Implementation Requirements:
This class is immutable and threadsafe.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 ==.
 See Also:
 Serialized Form


Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Days
abs()
Returns a copy of this duration with a positive length.java.time.temporal.Temporal
addTo(java.time.temporal.Temporal temporal)
Adds this amount to the specified temporal object.static Days
between(java.time.temporal.Temporal startDateInclusive, java.time.temporal.Temporal endDateExclusive)
Obtains aDays
consisting of the number of days between two dates.int
compareTo(Days otherAmount)
Compares this amount to the specifiedDays
.Days
dividedBy(int divisor)
Returns an instance with the amount divided by the specified divisor.boolean
equals(java.lang.Object otherAmount)
Checks if this amount is equal to the specifiedDays
.static Days
from(java.time.temporal.TemporalAmount amount)
Obtains an instance ofDays
from a temporal amount.long
get(java.time.temporal.TemporalUnit unit)
Gets the value of the requested unit.int
getAmount()
Gets the number of days in this amount.java.util.List<java.time.temporal.TemporalUnit>
getUnits()
Gets the set of units supported by this amount.int
hashCode()
A hash code for this amount.Days
minus(int days)
Returns a copy of this amount with the specified number of days subtracted.Days
minus(java.time.temporal.TemporalAmount amountToAdd)
Returns a copy of this amount with the specified amount subtracted.Days
multipliedBy(int scalar)
Returns an instance with the amount multiplied by the specified scalar.Days
negated()
Returns an instance with the amount negated.static Days
of(int days)
Obtains aDays
representing a number of days.static Days
ofWeeks(int weeks)
Obtains aDays
representing the number of days equivalent to a number of weeks.static Days
parse(java.lang.CharSequence text)
Obtains aDays
from a text string such asPnD
.Days
plus(int days)
Returns a copy of this amount with the specified number of days added.Days
plus(java.time.temporal.TemporalAmount amountToAdd)
Returns a copy of this amount with the specified amount added.java.time.temporal.Temporal
subtractFrom(java.time.temporal.Temporal temporal)
Subtracts this amount from the specified temporal object.java.time.Period
toPeriod()
Gets the number of days as aPeriod
.java.lang.String
toString()
Returns a string representation of the number of days.



Method Detail

of
public static Days of(int days)
Obtains aDays
representing a number of days.The resulting amount will have the specified days.
 Parameters:
days
 the number of days, positive or negative Returns:
 the number of days, not null

ofWeeks
public static Days ofWeeks(int weeks)
Obtains aDays
representing the number of days equivalent to a number of weeks.The resulting amount will be daybased, with the number of days equal to the number of weeks multiplied by 7.
 Parameters:
weeks
 the number of weeks, positive or negative Returns:
 the amount with the input weeks converted to days, not null
 Throws:
java.lang.ArithmeticException
 if numeric overflow occurs

from
public static Days from(java.time.temporal.TemporalAmount amount)
Obtains an instance ofDays
from a temporal amount.This obtains an instance based on the specified amount. A
TemporalAmount
represents an amount of time, which may be datebased or timebased, which this factory extracts to aDays
.The result is calculated by looping around each unit in the specified amount. Each amount is converted to days using
Temporals.convertAmount(long, java.time.temporal.TemporalUnit, java.time.temporal.TemporalUnit)
. If the conversion yields a remainder, an exception is thrown. If the amount is zero, the unit is ignored. Parameters:
amount
 the temporal amount to convert, not null Returns:
 the equivalent amount, not null
 Throws:
java.time.DateTimeException
 if unable to convert to aDays
java.lang.ArithmeticException
 if numeric overflow occurs

parse
public static Days parse(java.lang.CharSequence text)
Obtains aDays
from a text string such asPnD
.This will parse the string produced by
toString()
which is based on the ISO8601 period formatsPnD
andPnW
.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
int
.The leading plus/minus sign, and negative values for weeks and days are not part of the ISO8601 standard.
For example, the following are valid inputs:
"P2D"  Days.of(2) "P2D"  Days.of(2) "P2D"  Days.of(2) "P2D"  Days.of(2) "P3W"  Days.of(3 * 7) "P3W2D"  Days.of(3 * 7  2)
 Parameters:
text
 the text to parse, not null Returns:
 the parsed period, not null
 Throws:
java.time.format.DateTimeParseException
 if the text cannot be parsed to a period

between
public static Days between(java.time.temporal.Temporal startDateInclusive, java.time.temporal.Temporal endDateExclusive)
Obtains aDays
consisting of the number of days between two dates.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.
 Parameters:
startDateInclusive
 the start date, inclusive, not nullendDateExclusive
 the end date, exclusive, not null Returns:
 the number of days between this date and the end date, not null

get
public long get(java.time.temporal.TemporalUnit unit)
Gets the value of the requested unit.This returns a value for the supported unit 
DAYS
. All other units throw an exception. Specified by:
get
in interfacejava.time.temporal.TemporalAmount
 Parameters:
unit
 theTemporalUnit
for which to return the value Returns:
 the long value of the unit
 Throws:
java.time.temporal.UnsupportedTemporalTypeException
 if the unit is not supported

getUnits
public java.util.List<java.time.temporal.TemporalUnit> getUnits()
Gets the set of units supported by this amount.The single supported unit is
DAYS
.This set can be used in conjunction with
get(TemporalUnit)
to access the entire state of the amount. Specified by:
getUnits
in interfacejava.time.temporal.TemporalAmount
 Returns:
 a list containing the days unit, not null

getAmount
public int getAmount()
Gets the number of days in this amount. Returns:
 the number of days

plus
public Days plus(java.time.temporal.TemporalAmount amountToAdd)
Returns a copy of this amount with the specified amount added.The parameter is converted using
from(TemporalAmount)
.This instance is immutable and unaffected by this method call.
 Parameters:
amountToAdd
 the amount to add, not null Returns:
 a
Days
based on this instance with the requested amount added, not null  Throws:
java.time.DateTimeException
 if the specified amount contains an invalid unitjava.lang.ArithmeticException
 if numeric overflow occurs

plus
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.
 Parameters:
days
 the amount of days to add, may be negative Returns:
 a
Days
based on this instance with the requested amount added, not null  Throws:
java.lang.ArithmeticException
 if the result overflows an int

minus
public Days minus(java.time.temporal.TemporalAmount amountToAdd)
Returns a copy of this amount with the specified amount subtracted.The parameter is converted using
from(TemporalAmount)
.This instance is immutable and unaffected by this method call.
 Parameters:
amountToAdd
 the amount to add, not null Returns:
 a
Days
based on this instance with the requested amount subtracted, not null  Throws:
java.time.DateTimeException
 if the specified amount contains an invalid unitjava.lang.ArithmeticException
 if numeric overflow occurs

minus
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.
 Parameters:
days
 the amount of days to add, may be negative Returns:
 a
Days
based on this instance with the requested amount subtracted, not null  Throws:
java.lang.ArithmeticException
 if the result overflows an int

multipliedBy
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.
 Parameters:
scalar
 the scalar to multiply by, not null Returns:
 the amount multiplied by the specified scalar, not null
 Throws:
java.lang.ArithmeticException
 if numeric overflow occurs

dividedBy
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.
 Parameters:
divisor
 the amount to divide by, may be negative Returns:
 the amount divided by the specified divisor, not null
 Throws:
java.lang.ArithmeticException
 if the divisor is zero

negated
public Days negated()
Returns an instance with the amount negated.This instance is immutable and unaffected by this method call.
 Returns:
 the negated amount, not null
 Throws:
java.lang.ArithmeticException
 if numeric overflow occurs, which only happens if the amount isLong.MIN_VALUE

abs
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.
 Returns:
 the absolute amount, not null
 Throws:
java.lang.ArithmeticException
 if numeric overflow occurs, which only happens if the amount isLong.MIN_VALUE

toPeriod
public java.time.Period toPeriod()
Gets the number of days as aPeriod
.This returns a period with the same number of days.
 Returns:
 the equivalent period, not null

addTo
public java.time.temporal.Temporal addTo(java.time.temporal.Temporal temporal)
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
Temporal.plus(TemporalAmount)
.// these two lines are equivalent, but the second approach is recommended dateTime = thisAmount.addTo(dateTime); dateTime = dateTime.plus(thisAmount);
Only nonzero amounts will be added.
This instance is immutable and unaffected by this method call.
 Specified by:
addTo
in interfacejava.time.temporal.TemporalAmount
 Parameters:
temporal
 the temporal object to adjust, not null Returns:
 an object of the same type with the adjustment made, not null
 Throws:
java.time.DateTimeException
 if unable to addjava.time.temporal.UnsupportedTemporalTypeException
 if the DAYS unit is not supportedjava.lang.ArithmeticException
 if numeric overflow occurs

subtractFrom
public java.time.temporal.Temporal subtractFrom(java.time.temporal.Temporal temporal)
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
Temporal.minus(TemporalAmount)
.// these two lines are equivalent, but the second approach is recommended dateTime = thisAmount.subtractFrom(dateTime); dateTime = dateTime.minus(thisAmount);
Only nonzero amounts will be subtracted.
This instance is immutable and unaffected by this method call.
 Specified by:
subtractFrom
in interfacejava.time.temporal.TemporalAmount
 Parameters:
temporal
 the temporal object to adjust, not null Returns:
 an object of the same type with the adjustment made, not null
 Throws:
java.time.DateTimeException
 if unable to subtractjava.time.temporal.UnsupportedTemporalTypeException
 if the DAYS unit is not supportedjava.lang.ArithmeticException
 if numeric overflow occurs

compareTo
public int compareTo(Days otherAmount)
Compares this amount to the specifiedDays
.The comparison is based on the total length of the amounts. It is "consistent with equals", as defined by
Comparable
. Specified by:
compareTo
in interfacejava.lang.Comparable<Days>
 Parameters:
otherAmount
 the other amount, not null Returns:
 the comparator value, negative if less, positive if greater

equals
public boolean equals(java.lang.Object otherAmount)
Checks if this amount is equal to the specifiedDays
.The comparison is based on the total length of the durations.
 Overrides:
equals
in classjava.lang.Object
 Parameters:
otherAmount
 the other amount, null returns false Returns:
 true if the other amount is equal to this one

hashCode
public int hashCode()
A hash code for this amount. Overrides:
hashCode
in classjava.lang.Object
 Returns:
 a suitable hash code

toString
public java.lang.String toString()
Returns a string representation of the number of days. This will be in the format 'PnD' where n is the number of days. Overrides:
toString
in classjava.lang.Object
 Returns:
 the number of days in ISO8601 string format

