| java.lang.Object
 org.joda.time.base.BaseSingleFieldPeriod
org.joda.time.Years
| Years | | final public class Years extends BaseSingleFieldPeriod (Code) | | 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.
author:
Stephen Colebourne
since:
1.4 |
| Field Summary | |
| final public static Years | MAX_VALUE
Constant representing the maximum number of years that can be stored in this object. | | final public static Years | MIN_VALUE
Constant representing the minimum number of years that can be stored in this object. | | final public static Years | ONE
Constant representing one year. | | final public static Years | THREE
Constant representing three years. | | final public static Years | TWO
Constant representing two years. | | final public static Years | ZERO
Constant representing zero years. |
| Method Summary | |
| public Years | dividedBy(int divisor)
Returns a new instance with the years divided by the specified divisor. | | public DurationFieldType | getFieldType()
Gets the duration field type, which is years. | | public PeriodType | getPeriodType()
Gets the period type, which is years. | | public int | getYears()
Gets the number of years that this period represents. | | public boolean | isGreaterThan(Years other)
Is this years instance greater than the specified number of years. | | public boolean | isLessThan(Years other)
Is this years instance less than the specified number of years. | | public Years | minus(int years)
Returns a new instance with the specified number of years taken away. | | public Years | minus(Years years)
Returns a new instance with the specified number of years taken away. | | public Years | multipliedBy(int scalar)
Returns a new instance with the years multiplied by the specified scalar. | | public Years | negated()
Returns a new instance with the years value negated. | | 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. | | public Years | plus(int years)
Returns a new instance with the specified number of years added. | | public Years | plus(Years years)
Returns a new instance with the specified number of years added. | | public String | toString()
Gets this instance as a String in the ISO8601 duration format. | | public static Years | years(int years)
Obtains an instance of Years that may be cached. | | public static Years | yearsBetween(ReadableInstant start, ReadableInstant end)
Creates a Years representing the number of whole years
between the two specified datetimes. | | public static Years | yearsBetween(ReadablePartial start, ReadablePartial end)
Creates a Years representing the number of whole years
between the two specified partial datetimes. | | public static Years | yearsIn(ReadableInterval interval)
Creates a Years representing the number of whole years
in the specified interval. |
| MAX_VALUE | | final public static Years MAX_VALUE(Code) | | Constant representing the maximum number of years that can be stored in this object.
|
| MIN_VALUE | | final public static Years MIN_VALUE(Code) | | Constant representing the minimum number of years that can be stored in this object.
|
| ONE | | final public static Years ONE(Code) | | Constant representing one year.
|
| THREE | | final public static Years THREE(Code) | | Constant representing three years.
|
| TWO | | final public static Years TWO(Code) | | Constant representing two years.
|
| ZERO | | final public static Years ZERO(Code) | | Constant representing zero years.
|
| dividedBy | | public Years dividedBy(int divisor)(Code) | | 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 the new period divided by the specified divisor
throws:
ArithmeticException - if the divisor is zero |
| getFieldType | | public DurationFieldType getFieldType()(Code) | | Gets the duration field type, which is years.
the period type |
| getPeriodType | | public PeriodType getPeriodType()(Code) | | Gets the period type, which is years.
the period type |
| getYears | | public int getYears()(Code) | | Gets the number of years that this period represents.
the number of years in the period |
| isGreaterThan | | public boolean isGreaterThan(Years other)(Code) | | Is this years instance greater than the specified number of years.
Parameters:
other - the other period, null means zero true if this years instance is greater than the specified one |
| isLessThan | | public boolean isLessThan(Years other)(Code) | | Is this years instance less than the specified number of years.
Parameters:
other - the other period, null means zero true if this years instance is less than the specified one |
| minus | | public Years minus(int years)(Code) | | 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 the new period minus the specified number of years
throws:
ArithmeticException - if the result overflows an int |
| minus | | public Years minus(Years years)(Code) | | 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 the new period minus the specified number of years
throws:
ArithmeticException - if the result overflows an int |
| multipliedBy | | public Years multipliedBy(int scalar)(Code) | | 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 the new period multiplied by the specified scalar
throws:
ArithmeticException - if the result overflows an int |
| negated | | public Years negated()(Code) | | Returns a new instance with the years value negated.
the new period with a negated value
throws:
ArithmeticException - if the result overflows an int |
| parseYears | | public static Years parseYears(String periodStr)(Code) | | 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 the period in years
throws:
IllegalArgumentException - if the string format is invalid |
| plus | | public Years plus(int years)(Code) | | 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 the new period plus the specified number of years
throws:
ArithmeticException - if the result overflows an int |
| plus | | public Years plus(Years years)(Code) | | 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 the new period plus the specified number of years
throws:
ArithmeticException - if the result overflows an int |
| toString | | public String toString()(Code) | | Gets this instance as a String in the ISO8601 duration format.
For example, "P4Y" represents 4 years.
the value as an ISO8601 string |
| years | | public static Years years(int years)(Code) | | 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 the instance of Years |
| yearsBetween | | public static Years yearsBetween(ReadableInstant start, ReadableInstant end)(Code) | | 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
Parameters:
end - the end instant, must not be null the period in years
throws:
IllegalArgumentException - if the instants are null or invalid |
| yearsBetween | | public static Years yearsBetween(ReadablePartial start, ReadablePartial end)(Code) | | 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
Parameters:
end - the end partial date, must not be null the period in years
throws:
IllegalArgumentException - if the partials are null or invalid |
| yearsIn | | public static Years yearsIn(ReadableInterval interval)(Code) | | 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 the period in years
throws:
IllegalArgumentException - if the partials are null or invalid |
|
|