Days (ThreeTen date and time API)

java.lang.Object
- javax.time.period.field.PeriodField
- - javax.time.period.field.Days

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Days>
```
public final class Days
extends PeriodField
implements java.lang.Comparable<Days>, java.io.Serializable
```
A period representing a number of days.
Days is an immutable period that can only store days. It is a type-safe way of representing a number of days in an application.
Static factory methods allow you to construct instances. The number of days may be queried using getDays(). Basic mathematical operations are provided - plus(), minus(), multipliedBy(), dividedBy() and negated(), all of which return a new instance
Days is immutable and thread-safe.

Author:

Stephen Colebourne

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Days ZERO
A constant for zero days.

Fields
Modifier and Type	Field and Description
`static Days`	`ZERO` A constant for zero days.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Days otherDays)` Compares the number of days in this instance to another instance.
`Days`	`dividedBy(int divisor)` Returns a new instance with the days divided by the specified divisor.
`int`	`getAmount()` Gets the number of days held in this period.
`PeriodUnit`	`getUnit()` Gets the unit defining the amount of time.
`boolean`	`isGreaterThan(Days otherDays)` Is the number of days in this instance greater than that in another instance.
`boolean`	`isLessThan(Days otherDays)` Is the number of days in this instance less than that in another instance.
`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`	`of(int days)` Obtains an instance of `Days`.
`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.
`java.lang.String`	`toString()` Returns a string representation of the number of days.
`Days`	`withAmount(int amount)` Returns a new instance of the subclass with a different number of days.

Methods inherited from class javax.time.period.field.PeriodField
equals, hashCode, toPeriodFields

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO
```
public static final Days ZERO
```
    A constant for zero days.
- Method Detail
  - of
```
public static Days of(int days)
```
    Obtains an instance of Days.
    
    Parameters:
    days - the number of days the instance will represent
    
    Returns:
    the created Days
  - getAmount
```
public int getAmount()
```
    Gets the number of days held in this period.
    
    Specified by:
    
    getAmount in class PeriodField
    
    Returns:
    the number of days
  - withAmount
```
public Days withAmount(int amount)
```
    Returns a new instance of the subclass with a different number of days.
    
    Specified by:
    
    withAmount in class PeriodField
    
    Parameters:
    amount - the number of days to set in the new instance, may be negative
    
    Returns:
    a new period element, never null
  - getUnit
```
public PeriodUnit getUnit()
```
    Gets the unit defining the amount of time.
    
    Specified by:
    
    getUnit in class PeriodField
    
    Returns:
    the days unit, never null
  - plus
```
public Days plus(int days)
```
    Returns a new instance with the specified number of days added.
    This instance is immutable and unaffected by this method call.
    
    Overrides:
    
    plus in class PeriodField
    
    Parameters:
    days - the amount of days to add, may be negative
    
    Returns:
    the new period plus the specified number of days
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - plus
```
public Days plus(Days days)
```
    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, not null
    
    Returns:
    the new period plus the specified number of days
    
    Throws:
    
    java.lang.NullPointerException - if the days to add is null
    
    java.lang.ArithmeticException - if the result overflows an int
  - minus
```
public Days minus(int days)
```
    Returns a new instance with the specified number of days taken away.
    This instance is immutable and unaffected by this method call.
    
    Overrides:
    
    minus in class PeriodField
    
    Parameters:
    days - the amount of days to take away, may be negative
    
    Returns:
    the new period minus the specified number of days
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - minus
```
public Days minus(Days days)
```
    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, not null
    
    Returns:
    the new period minus the specified number of days
    
    Throws:
    
    java.lang.NullPointerException - if the days to add is null
    
    java.lang.ArithmeticException - if the result overflows an int
  - multipliedBy
```
public Days multipliedBy(int scalar)
```
    Returns a new instance with the days multiplied by the specified scalar.
    This instance is immutable and unaffected by this method call.
    
    Overrides:
    
    multipliedBy in class PeriodField
    
    Parameters:
    scalar - the amount to multiply by, may be negative
    
    Returns:
    the new period multiplied by the specified scalar
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - dividedBy
```
public Days dividedBy(int divisor)
```
    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.
    
    Overrides:
    
    dividedBy in class PeriodField
    
    Parameters:
    divisor - the amount to divide by, may be negative
    
    Returns:
    the new period divided by the specified divisor
    
    Throws:
    
    java.lang.ArithmeticException - if the divisor is zero
  - negated
```
public Days negated()
```
    Returns a new instance with the days value negated.
    
    Overrides:
    
    negated in class PeriodField
    
    Returns:
    the new period with a negated value
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - compareTo
```
public int compareTo(Days otherDays)
```
    Compares the number of days in this instance to another instance.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Days>
    
    Parameters:
    otherDays - the other number of days, not null
    
    Returns:
    the comparator value, negative if less, postive if greater
    
    Throws:
    
    java.lang.NullPointerException - if otherDays is null
  - isGreaterThan
```
public boolean isGreaterThan(Days otherDays)
```
    Is the number of days in this instance greater than that in another instance.
    
    Parameters:
    otherDays - the other number of days, not null
    
    Returns:
    true if this number of days is greater
    
    Throws:
    
    java.lang.NullPointerException - if otherDays is null
  - isLessThan
```
public boolean isLessThan(Days otherDays)
```
    Is the number of days in this instance less than that in another instance.
    
    Parameters:
    otherDays - the other number of days, not null
    
    Returns:
    true if this number of days is less
    
    Throws:
    
    java.lang.NullPointerException - if otherDays is null
  - 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.
    
    Specified by:
    
    toString in class PeriodField
    
    Returns:
    the number of days in ISO8601 string format

Class Days

Field Summary

Method Summary

Methods inherited from class javax.time.period.field.PeriodField

Methods inherited from class java.lang.Object

Field Detail

ZERO

Method Detail

of

getAmount

withAmount

getUnit

plus

plus

minus

minus

multipliedBy

dividedBy

negated

compareTo

isGreaterThan

isLessThan

toString