Client and backend. This class is shared: the same code is compiled into your app and into your server, so everything on this page works in both.

public final class Period

  1. Object
  2. Period

ImplementsTemporalAmount

An amount of calendar time in years, months and days, such as “2 years, 3 months and 4 days”. The three are kept apart and never converted into one another except by normalized.

Fields

public static final Period ZERO

Methods

public static Period of(int years, int months, int days)
public static Period ofDays(int days)
public static Period ofWeeks(int weeks)
public static Period ofMonths(int months)
public static Period ofYears(int years)
public static Period between(LocalDate startDateInclusive, LocalDate endDateExclusive)The years, months and days from startDateInclusive to endDateExclusive.
public static Period from(TemporalAmount amount)The period of amount, which must be in years, months and days.
public static Period parse(CharSequence text)Reads PnYnMnWnD: each section optional but at least one present, each number signed, the letters in either case, and a leading sign negating the whole.
public long get(TemporalUnit unit)The amount of unit this holds.
public List<TemporalUnit> getUnits()The units this amount is made of.
public int getYears()
public int getMonths()
public int getDays()
public boolean isZero()
public boolean isNegative()
public Period withYears(int years)
public Period withMonths(int months)
public Period withDays(int days)
public Period plus(TemporalAmount amountToAdd)This period plus amountToAdd, which must be in years, months and days; each unit is added to its own.
public Period minus(TemporalAmount amountToSubtract)
public Period plusYears(long yearsToAdd)
public Period plusMonths(long monthsToAdd)
public Period plusDays(long daysToAdd)
public Period minusYears(long yearsToSubtract)
public Period minusMonths(long monthsToSubtract)
public Period minusDays(long daysToSubtract)
public Period multipliedBy(int scalar)
public Period negated()
public Period normalized()The years and months rebalanced so that the months lie within -11 to 11 with the sign of the years; the days are left as they are.
public long toTotalMonths()
public Temporal addTo(Temporal temporal)Adds the years and months together, then the days, as the JDK does: a date at the end of a month stays valid in between.
public Temporal subtractFrom(Temporal temporal)temporal moved back by this amount.
public boolean equals(Object obj)Indicates whether some other object is “equal to” this one.
public int hashCode()Returns a hash code value for the object.
public String toString()Returns a string representation of the object.

Inherited methods

Field details

ZERO

public static final Period ZERO

Method details

of

public static Period of(int years, int months, int days)

ofDays

public static Period ofDays(int days)

ofWeeks

public static Period ofWeeks(int weeks)

ofMonths

public static Period ofMonths(int months)

ofYears

public static Period ofYears(int years)

between

public static Period between(LocalDate startDateInclusive, LocalDate endDateExclusive)
The years, months and days from startDateInclusive to endDateExclusive.

from

public static Period from(TemporalAmount amount)
The period of amount, which must be in years, months and days.

parse

public static Period parse(CharSequence text)
Reads PnYnMnWnD: each section optional but at least one present, each number signed, the letters in either case, and a leading sign negating the whole. Weeks are added to the days.

get

public long get(TemporalUnit unit)
The amount of unit this holds.

getUnits

public List<TemporalUnit> getUnits()
The units this amount is made of.

getYears

public int getYears()

getMonths

public int getMonths()

getDays

public int getDays()

isZero

public boolean isZero()

isNegative

public boolean isNegative()

withYears

public Period withYears(int years)

withMonths

public Period withMonths(int months)

withDays

public Period withDays(int days)

plus

public Period plus(TemporalAmount amountToAdd)
This period plus amountToAdd, which must be in years, months and days; each unit is added to its own.

minus

public Period minus(TemporalAmount amountToSubtract)

plusYears

public Period plusYears(long yearsToAdd)

plusMonths

public Period plusMonths(long monthsToAdd)

plusDays

public Period plusDays(long daysToAdd)

minusYears

public Period minusYears(long yearsToSubtract)

minusMonths

public Period minusMonths(long monthsToSubtract)

minusDays

public Period minusDays(long daysToSubtract)

multipliedBy

public Period multipliedBy(int scalar)

negated

public Period negated()

normalized

public Period normalized()
The years and months rebalanced so that the months lie within -11 to 11 with the sign of the years; the days are left as they are.

toTotalMonths

public long toTotalMonths()

addTo

public Temporal addTo(Temporal temporal)
Adds the years and months together, then the days, as the JDK does: a date at the end of a month stays valid in between.

subtractFrom

public Temporal subtractFrom(Temporal temporal)
temporal moved back by this amount.

equals

public boolean equals(Object obj)
Indicates whether some other object is “equal to” this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

toString

public String toString()
Returns a string representation of the object. In general, the toString method returns a string that “textually represents” this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@’, and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + ‘@’ + Integer.toHexString(hashCode())