Package org.threeten.extra

Class Years

java.lang.Object
org.threeten.extra.Years
All Implemented Interfaces:
Serializable, Comparable<Years>, TemporalAmount
public final class Years extends Object implements TemporalAmount, Comparable<Years>, Serializable
A year-based amount of time, such as '12 years'.

This class models a quantity or amount of time in terms of years. It is a type-safe way of representing a number of years in an application.

The model is of a directed amount, meaning that the amount may be negative.

Implementation Requirements:

This class is immutable and thread-safe.

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:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Years
    ONE
    A constant for one year.
    static final Years
    ZERO
    A constant for zero years.

  • Method Summary

    Modifier and Type
    Method
    Description
    Years
    abs()
    Returns a copy of this duration with a positive length.
    Temporal
    addTo(Temporal temporal)
    Adds this amount to the specified temporal object.
    static Years
    between(Temporal startDateInclusive, Temporal endDateExclusive)
    Obtains a Years consisting of the number of years between two dates.
    int
    compareTo(Years otherAmount)
    Compares this amount to the specified Years.
    Years
    dividedBy(int divisor)
    Returns an instance with the amount divided by the specified divisor.
    boolean
    equals(Object otherAmount)
    Checks if this amount is equal to the specified Years.
    static Years
    from(TemporalAmount amount)
    Obtains an instance of Years from a temporal amount.
    long
    get(TemporalUnit unit)
    Gets the value of the requested unit.
    int
    getAmount()
    Gets the number of years in this amount.
    List<TemporalUnit>
    getUnits()
    Gets the set of units supported by this amount.
    int
    hashCode()
    A hash code for this amount.
    boolean
    isNegative()
    Checks if the amount is negative.
    boolean
    isPositive()
    Checks if the amount is positive.
    boolean
    isZero()
    Checks if the amount is zero.
    Years
    minus(int years)
    Returns a copy of this amount with the specified number of years subtracted.
    Years
    minus(TemporalAmount amountToSubtract)
    Returns a copy of this amount with the specified amount subtracted.
    Years
    multipliedBy(int scalar)
    Returns an instance with the amount multiplied by the specified scalar.
    Years
    negated()
    Returns an instance with the amount negated.
    static Years
    of(int years)
    Obtains a Years representing a number of years.
    static Years
    parse(CharSequence text)
    Obtains a Years from a text string such as PnY.
    Years
    plus(int years)
    Returns a copy of this amount with the specified number of years added.
    Years
    plus(TemporalAmount amountToAdd)
    Returns a copy of this amount with the specified amount added.
    Temporal
    subtractFrom(Temporal temporal)
    Subtracts this amount from the specified temporal object.
    Period
    toPeriod()
    Gets the number of years as a Period.
    String
    toString()
    Returns a string representation of the number of years.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • ZERO

      public static final Years ZERO
      A constant for zero years.

    • ONE

      public static final Years ONE
      A constant for one year.

  • Method Details

    • of

      public static Years of(int years)
      Obtains a Years representing a number of years.

      The resulting amount will have the specified years.

      Parameters:
      years - the number of years, positive or negative
      Returns:
      the number of years, not null

    • from

      public static Years from(TemporalAmount amount)
      Obtains an instance of Years from a temporal amount.

      This obtains an instance based on the specified amount. A TemporalAmount represents an amount of time, which may be date-based or time-based, which this factory extracts to a Years.

      The result is calculated by looping around each unit in the specified amount. Each amount is converted to years 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. For example, "12 months" can be converted to years but "11 months" cannot.

      Parameters:
      amount - the temporal amount to convert, not null
      Returns:
      the equivalent amount, not null
      Throws:
      DateTimeException - if unable to convert to a Years
      ArithmeticException - if numeric overflow occurs

    • parse

      public static Years parse(CharSequence text)
      Obtains a Years from a text string such as PnY.

      This will parse the string produced by toString() which is based on the ISO-8601 period formats PnY.

      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. The ASCII integer amount is next, which may be negative. The ASCII letter "Y" is next in upper or lower case.

      The leading plus/minus sign, and negative values for years are not part of the ISO-8601 standard.

      For example, the following are valid inputs: 

         "P2Y"             -- Years.of(2)
   "P-2Y"            -- Years.of(-2)
   "-P2Y"            -- Years.of(-2)
   "-P-2Y"           -- Years.of(2)
      Parameters:
      text - the text to parse, not null
      Returns:
      the parsed period, not null
      Throws:
      DateTimeParseException - if the text cannot be parsed to a period

    • between

      public static Years between(Temporal startDateInclusive, Temporal endDateExclusive)
      Obtains a Years consisting of the number of years 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 null
      endDateExclusive - the end date, exclusive, not null
      Returns:
      the number of years between this date and the end date, not null

    • get

      public long get(TemporalUnit unit)
      Gets the value of the requested unit.

      This returns a value for the supported unit - YEARS. All other units throw an exception.

      Specified by:
      get in interface TemporalAmount
      Parameters:
      unit - the TemporalUnit for which to return the value
      Returns:
      the long value of the unit
      Throws:
      UnsupportedTemporalTypeException - if the unit is not supported

    • getUnits

      public List<TemporalUnit> getUnits()
      Gets the set of units supported by this amount.

      The single supported unit is YEARS.

      This set can be used in conjunction with get(TemporalUnit) to access the entire state of the amount.

      Specified by:
      getUnits in interface TemporalAmount
      Returns:
      a list containing the years unit, not null

    • getAmount

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

    • isNegative

      public boolean isNegative()
      Checks if the amount is negative.
      Returns:
      true if the amount is negative, false if the amount is zero or positive

    • isZero

      public boolean isZero()
      Checks if the amount is zero.
      Returns:
      true if the amount is zero, false if not

    • isPositive

      public boolean isPositive()
      Checks if the amount is positive.
      Returns:
      true if the amount is positive, false if the amount is zero or negative

    • plus

      public Years plus(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 Years based on this instance with the requested amount added, not null
      Throws:
      DateTimeException - if the specified amount contains an invalid unit
      ArithmeticException - if numeric overflow occurs

    • plus

      public Years plus(int years)
      Returns a copy of this amount with the specified number of years added.

      This instance is immutable and unaffected by this method call.

      Parameters:
      years - the amount of years to add, may be negative
      Returns:
      a Years based on this instance with the requested amount added, not null
      Throws:
      ArithmeticException - if the result overflows an int

    • minus

      public Years minus(TemporalAmount amountToSubtract)
      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:
      amountToSubtract - the amount to subtract, not null
      Returns:
      a Years based on this instance with the requested amount subtracted, not null
      Throws:
      DateTimeException - if the specified amount contains an invalid unit
      ArithmeticException - if numeric overflow occurs

    • minus

      public Years minus(int years)
      Returns a copy of this amount with the specified number of years subtracted.

      This instance is immutable and unaffected by this method call.

      Parameters:
      years - the amount of years to add, may be negative
      Returns:
      a Years based on this instance with the requested amount subtracted, not null
      Throws:
      ArithmeticException - if the result overflows an int

    • multipliedBy

      public Years 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:
      ArithmeticException - if numeric overflow occurs

    • dividedBy

      public Years 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:
      ArithmeticException - if the divisor is zero

    • negated

      public Years 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:
      ArithmeticException - if numeric overflow occurs, which only happens if the amount is Long.MIN_VALUE

    • abs

      public Years 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:
      ArithmeticException - if numeric overflow occurs, which only happens if the amount is Long.MIN_VALUE

    • toPeriod

      public Period toPeriod()
      Gets the number of years as a Period.

      This returns a period with the same number of years.

      Returns:
      the equivalent period, not null

    • addTo

      public Temporal addTo(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 non-zero amounts will be added.

      This instance is immutable and unaffected by this method call.

      Specified by:
      addTo in interface TemporalAmount
      Parameters:
      temporal - the temporal object to adjust, not null
      Returns:
      an object of the same type with the adjustment made, not null
      Throws:
      DateTimeException - if unable to add
      UnsupportedTemporalTypeException - if the YEARS unit is not supported
      ArithmeticException - if numeric overflow occurs

    • subtractFrom

      public Temporal subtractFrom(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 non-zero amounts will be subtracted.

      This instance is immutable and unaffected by this method call.

      Specified by:
      subtractFrom in interface TemporalAmount
      Parameters:
      temporal - the temporal object to adjust, not null
      Returns:
      an object of the same type with the adjustment made, not null
      Throws:
      DateTimeException - if unable to subtract
      UnsupportedTemporalTypeException - if the YEARS unit is not supported
      ArithmeticException - if numeric overflow occurs

    • compareTo

      public int compareTo(Years otherAmount)
      Compares this amount to the specified Years.

      The comparison is based on the total length of the amounts. It is "consistent with equals", as defined by Comparable.

      Specified by:
      compareTo in interface Comparable<Years>
      Parameters:
      otherAmount - the other amount, not null
      Returns:
      the comparator value, negative if less, positive if greater

    • equals

      public boolean equals(Object otherAmount)
      Checks if this amount is equal to the specified Years.

      The comparison is based on the total length of the durations.

      Overrides:
      equals in class 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 class Object
      Returns:
      a suitable hash code

    • toString

      public String toString()
      Returns a string representation of the number of years. This will be in the format 'PnY' where n is the number of years.
      Overrides:
      toString in class Object
      Returns:
      the number of years in ISO-8601 string format