public final class

Years

extends BaseSingleFieldPeriod
java.lang.Object
   ↳ org.joda.time.base.BaseSingleFieldPeriod
     ↳ org.joda.time.Years

Class Overview

An immutable time period representing a number of years.

Years is an immutable period that can only store years. It does not store years, days or hours for example. As such it is a type-safe way of representing a number of years in an application.

The number of years is set in the constructor, and may be queried using getYears(). Basic mathematical operations are provided - plus(), minus(), multipliedBy() and dividedBy().

Years is thread-safe and immutable.

Summary

Fields
public static final Years MAX_VALUE Constant representing the maximum number of years that can be stored in this object.
public static final Years MIN_VALUE Constant representing the minimum number of years that can be stored in this object.
public static final Years ONE Constant representing one year.
public static final Years THREE Constant representing three years.
public static final Years TWO Constant representing two years.
public static final Years ZERO Constant representing zero years.
Public Methods
Years dividedBy(int divisor)
Returns a new instance with the years divided by the specified divisor.
DurationFieldType getFieldType()
Gets the duration field type, which is years.
PeriodType getPeriodType()
Gets the period type, which is years.
int getYears()
Gets the number of years that this period represents.
boolean isGreaterThan(Years other)
Is this years instance greater than the specified number of years.
boolean isLessThan(Years other)
Is this years instance less than the specified number of years.
Years minus(Years years)
Returns a new instance with the specified number of years taken away.
Years minus(int years)
Returns a new instance with the specified number of years taken away.
Years multipliedBy(int scalar)
Returns a new instance with the years multiplied by the specified scalar.
Years negated()
Returns a new instance with the years value negated.
static Years parseYears(String periodStr)
Creates a new Years by parsing a string in the ISO8601 format 'PnY'.
Years plus(Years years)
Returns a new instance with the specified number of years added.
Years plus(int years)
Returns a new instance with the specified number of years added.
String toString()
Gets this instance as a String in the ISO8601 duration format.
static Years years(int years)
Obtains an instance of Years that may be cached.
static Years yearsBetween(ReadableInstant start, ReadableInstant end)
Creates a Years representing the number of whole years between the two specified datetimes.
static Years yearsBetween(ReadablePartial start, ReadablePartial end)
Creates a Years representing the number of whole years between the two specified partial datetimes.
static Years yearsIn(ReadableInterval interval)
Creates a Years representing the number of whole years in the specified interval.
[Expand]
Inherited Methods
From class org.joda.time.base.BaseSingleFieldPeriod
From class java.lang.Object
From interface java.lang.Comparable
From interface org.joda.time.ReadablePeriod

Fields

public static final Years MAX_VALUE

Constant representing the maximum number of years that can be stored in this object.

public static final Years MIN_VALUE

Constant representing the minimum number of years that can be stored in this object.

public static final Years ONE

Constant representing one year.

public static final Years THREE

Constant representing three years.

public static final Years TWO

Constant representing two years.

public static final Years ZERO

Constant representing zero years.

Public Methods

public Years dividedBy (int divisor)

Returns a new instance with the years 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 new period divided by the specified divisor
Throws
ArithmeticException if the divisor is zero

public DurationFieldType getFieldType ()

Gets the duration field type, which is years.

Returns
  • the period type

public PeriodType getPeriodType ()

Gets the period type, which is years.

Returns
  • the period type

public int getYears ()

Gets the number of years that this period represents.

Returns
  • the number of years in the period

public boolean isGreaterThan (Years other)

Is this years instance greater than the specified number of years.

Parameters
other the other period, null means zero
Returns
  • true if this years instance is greater than the specified one

public boolean isLessThan (Years other)

Is this years instance less than the specified number of years.

Parameters
other the other period, null means zero
Returns
  • true if this years instance is less than the specified one

public Years minus (Years years)

Returns a new instance with the specified number of years taken away.

This instance is immutable and unaffected by this method call.

Parameters
years the amount of years to take away, may be negative, null means zero
Returns
  • the new period minus the specified number of years
Throws
ArithmeticException if the result overflows an int

public Years minus (int years)

Returns a new instance with the specified number of years taken away.

This instance is immutable and unaffected by this method call.

Parameters
years the amount of years to take away, may be negative
Returns
  • the new period minus the specified number of years
Throws
ArithmeticException if the result overflows an int

public Years multipliedBy (int scalar)

Returns a new instance with the years multiplied by the specified scalar.

This instance is immutable and unaffected by this method call.

Parameters
scalar the amount to multiply by, may be negative
Returns
  • the new period multiplied by the specified scalar
Throws
ArithmeticException if the result overflows an int

public Years negated ()

Returns a new instance with the years value negated.

Returns
  • the new period with a negated value
Throws
ArithmeticException if the result overflows an int

public static Years parseYears (String periodStr)

Creates a new Years by parsing a string in the ISO8601 format 'PnY'.

The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the years component may be non-zero. If any other component is non-zero, an exception will be thrown.

Parameters
periodStr the period string, null returns zero
Returns
  • the period in years
Throws
IllegalArgumentException if the string format is invalid

public Years plus (Years years)

Returns a new instance 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, null means zero
Returns
  • the new period plus the specified number of years
Throws
ArithmeticException if the result overflows an int

public Years plus (int years)

Returns a new instance 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
  • the new period plus the specified number of years
Throws
ArithmeticException if the result overflows an int

public String toString ()

Gets this instance as a String in the ISO8601 duration format.

For example, "P4Y" represents 4 years.

Returns
  • the value as an ISO8601 string

public static Years years (int years)

Obtains an instance of Years that may be cached. Years is immutable, so instances can be cached and shared. This factory method provides access to shared instances.

Parameters
years the number of years to obtain an instance for
Returns
  • the instance of Years

public static Years yearsBetween (ReadableInstant start, ReadableInstant end)

Creates a Years representing the number of whole years between the two specified datetimes. This method corectly handles any daylight savings time changes that may occur during the interval.

Parameters
start the start instant, must not be null
end the end instant, must not be null
Returns
  • the period in years
Throws
IllegalArgumentException if the instants are null or invalid

public static Years yearsBetween (ReadablePartial start, ReadablePartial end)

Creates a Years representing the number of whole years between the two specified partial datetimes.

The two partials must contain the same fields, for example you can specify two LocalDate objects.

Parameters
start the start partial date, must not be null
end the end partial date, must not be null
Returns
  • the period in years
Throws
IllegalArgumentException if the partials are null or invalid

public static Years yearsIn (ReadableInterval interval)

Creates a Years representing the number of whole years in the specified interval. This method corectly handles any daylight savings time changes that may occur during the interval.

Parameters
interval the interval to extract years from, null returns zero
Returns
  • the period in years
Throws
IllegalArgumentException if the partials are null or invalid