- java.lang.Object
-
- java.time.Year
-
- All Implemented Interfaces:
Serializable,Comparable<Year>,Temporal,TemporalAccessor,TemporalAdjuster
public final class Year extends Object implements Temporal, TemporalAdjuster, Comparable<Year>, Serializable
A year in the ISO-8601 calendar system, such as2007.Yearis an immutable date-time object that represents a year. Any field that can be derived from a year can be obtained.Note that years in the ISO chronology only align with years in the Gregorian-Julian system for modern years. Parts of Russia did not switch to the modern Gregorian/ISO rules until 1920. As such, historical years must be treated with caution.
This class does not store or represent a month, day, time or time-zone. For example, the value "2007" can be stored in a
Year.Years represented by this class follow the ISO-8601 standard and use the proleptic numbering system. Year 1 is preceded by year 0, then by year -1.
The ISO-8601 calendar system is the modern civil calendar system used today in most of the world. It is equivalent to the proleptic Gregorian calendar system, in which today's rules for leap years are applied for all time. For most applications written today, the ISO-8601 rules are entirely suitable. However, any application that makes use of historical dates, and requires them to be accurate will find the ISO-8601 approach unsuitable.
This is a value-based class; use of identity-sensitive operations (including reference equality (
==), identity hash code, or synchronization) on instances ofYearmay have unpredictable results and should be avoided. Theequalsmethod should be used for comparisons.- Implementation Requirements:
- This class is immutable and thread-safe.
- Since:
- 1.8
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TemporaladjustInto(Temporal temporal)Adjusts the specified temporal object to have this year.LocalDateatDay(int dayOfYear)Combines this year with a day-of-year to create aLocalDate.YearMonthatMonth(int month)Combines this year with a month to create aYearMonth.YearMonthatMonth(Month month)Combines this year with a month to create aYearMonth.LocalDateatMonthDay(MonthDay monthDay)Combines this year with a month-day to create aLocalDate.intcompareTo(Year other)Compares this year to another year.booleanequals(Object obj)Checks if this year is equal to another year.Stringformat(DateTimeFormatter formatter)Formats this year using the specified formatter.static Yearfrom(TemporalAccessor temporal)Obtains an instance ofYearfrom a temporal object.intget(TemporalField field)Gets the value of the specified field from this year as anint.longgetLong(TemporalField field)Gets the value of the specified field from this year as along.intgetValue()Gets the year value.inthashCode()A hash code for this year.booleanisAfter(Year other)Checks if this year is after the specified year.booleanisBefore(Year other)Checks if this year is before the specified year.booleanisLeap()Checks if the year is a leap year, according to the ISO proleptic calendar system rules.static booleanisLeap(long year)Checks if the year is a leap year, according to the ISO proleptic calendar system rules.booleanisSupported(TemporalField field)Checks if the specified field is supported.booleanisSupported(TemporalUnit unit)Checks if the specified unit is supported.booleanisValidMonthDay(MonthDay monthDay)Checks if the month-day is valid for this year.intlength()Gets the length of this year in days.Yearminus(long amountToSubtract, TemporalUnit unit)Returns a copy of this year with the specified amount subtracted.Yearminus(TemporalAmount amountToSubtract)Returns a copy of this year with the specified amount subtracted.YearminusYears(long yearsToSubtract)Returns a copy of thisYearwith the specified number of years subtracted.static Yearnow()Obtains the current year from the system clock in the default time-zone.static Yearnow(Clock clock)Obtains the current year from the specified clock.static Yearnow(ZoneId zone)Obtains the current year from the system clock in the specified time-zone.static Yearof(int isoYear)Obtains an instance ofYear.static Yearparse(CharSequence text)Obtains an instance ofYearfrom a text string such as2007.static Yearparse(CharSequence text, DateTimeFormatter formatter)Obtains an instance ofYearfrom a text string using a specific formatter.Yearplus(long amountToAdd, TemporalUnit unit)Returns a copy of this year with the specified amount added.Yearplus(TemporalAmount amountToAdd)Returns a copy of this year with the specified amount added.YearplusYears(long yearsToAdd)Returns a copy of thisYearwith the specified number of years added.<R> Rquery(TemporalQuery<R> query)Queries this year using the specified query.ValueRangerange(TemporalField field)Gets the range of valid values for the specified field.StringtoString()Outputs this year as aString.longuntil(Temporal endExclusive, TemporalUnit unit)Calculates the amount of time until another year in terms of the specified unit.Yearwith(TemporalAdjuster adjuster)Returns an adjusted copy of this year.Yearwith(TemporalField field, long newValue)Returns a copy of this year with the specified field set to a new value.
-
-
-
Field Detail
-
MIN_VALUE
public static final int MIN_VALUE
The minimum supported year, '-999,999,999'.- See Also:
- Constant Field Values
-
MAX_VALUE
public static final int MAX_VALUE
The maximum supported year, '+999,999,999'.- See Also:
- Constant Field Values
-
-
Method Detail
-
now
public static Year now()
Obtains the current year from the system clock in the default time-zone.This will query the
system clockin the default time-zone to obtain the current year.Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
- Returns:
- the current year using the system clock and default time-zone, not null
-
now
public static Year now(ZoneId zone)
Obtains the current year from the system clock in the specified time-zone.This will query the
system clockto obtain the current year. Specifying the time-zone avoids dependence on the default time-zone.Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
- Parameters:
zone- the zone ID to use, not null- Returns:
- the current year using the system clock, not null
-
now
public static Year now(Clock clock)
Obtains the current year from the specified clock.This will query the specified clock to obtain the current year. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using
dependency injection.- Parameters:
clock- the clock to use, not null- Returns:
- the current year, not null
-
of
public static Year of(int isoYear)
Obtains an instance ofYear.This method accepts a year value from the proleptic ISO calendar system.
The year 2AD/CE is represented by 2.
The year 1AD/CE is represented by 1.
The year 1BC/BCE is represented by 0.
The year 2BC/BCE is represented by -1.- Parameters:
isoYear- the ISO proleptic year to represent, fromMIN_VALUEtoMAX_VALUE- Returns:
- the year, not null
- Throws:
DateTimeException- if the field is invalid
-
from
public static Year from(TemporalAccessor temporal)
Obtains an instance ofYearfrom a temporal object.This obtains a year based on the specified temporal. A
TemporalAccessorrepresents an arbitrary set of date and time information, which this factory converts to an instance ofYear.The conversion extracts the
yearfield. The extraction is only permitted if the temporal object has an ISO chronology, or can be converted to aLocalDate.This method matches the signature of the functional interface
TemporalQueryallowing it to be used as a query via method reference,Year::from.- Parameters:
temporal- the temporal object to convert, not null- Returns:
- the year, not null
- Throws:
DateTimeException- if unable to convert to aYear
-
parse
public static Year parse(CharSequence text)
Obtains an instance ofYearfrom a text string such as2007.The string must represent a valid year. Years outside the range 0000 to 9999 must be prefixed by the plus or minus symbol.
- Parameters:
text- the text to parse such as "2007", not null- Returns:
- the parsed year, not null
- Throws:
DateTimeParseException- if the text cannot be parsed
-
parse
public static Year parse(CharSequence text, DateTimeFormatter formatter)
Obtains an instance ofYearfrom a text string using a specific formatter.The text is parsed using the formatter, returning a year.
- Parameters:
text- the text to parse, not nullformatter- the formatter to use, not null- Returns:
- the parsed year, not null
- Throws:
DateTimeParseException- if the text cannot be parsed
-
isLeap
public static boolean isLeap(long year)
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.This method applies the current rules for leap years across the whole time-line. In general, a year is a leap year if it is divisible by four without remainder. However, years divisible by 100, are not leap years, with the exception of years divisible by 400 which are.
For example, 1904 is a leap year it is divisible by 4. 1900 was not a leap year as it is divisible by 100, however 2000 was a leap year as it is divisible by 400.
The calculation is proleptic - applying the same rules into the far future and far past. This is historically inaccurate, but is correct for the ISO-8601 standard.
- Parameters:
year- the year to check- Returns:
- true if the year is leap, false otherwise
-
getValue
public int getValue()
Gets the year value.The year returned by this method is proleptic as per
get(YEAR).- Returns:
- the year,
MIN_VALUEtoMAX_VALUE
-
isSupported
public boolean isSupported(TemporalField field)
Checks if the specified field is supported.This checks if this year can be queried for the specified field. If false, then calling the
range,getandwith(TemporalField, long)methods will throw an exception.If the field is a
ChronoFieldthen the query is implemented here. The supported fields are:YEAR_OF_ERAYEARERA
ChronoFieldinstances will return false.If the field is not a
ChronoField, then the result of this method is obtained by invokingTemporalField.isSupportedBy(TemporalAccessor)passingthisas the argument. Whether the field is supported is determined by the field.- Specified by:
isSupportedin interfaceTemporalAccessor- Parameters:
field- the field to check, null returns false- Returns:
- true if the field is supported on this year, false if not
-
isSupported
public boolean isSupported(TemporalUnit unit)
Checks if the specified unit is supported.This checks if the specified unit can be added to, or subtracted from, this year. If false, then calling the
plus(long, TemporalUnit)andminusmethods will throw an exception.If the unit is a
ChronoUnitthen the query is implemented here. The supported units are:YEARSDECADESCENTURIESMILLENNIAERAS
ChronoUnitinstances will return false.If the unit is not a
ChronoUnit, then the result of this method is obtained by invokingTemporalUnit.isSupportedBy(Temporal)passingthisas the argument. Whether the unit is supported is determined by the unit.- Specified by:
isSupportedin interfaceTemporal- Parameters:
unit- the unit to check, null returns false- Returns:
- true if the unit can be added/subtracted, false if not
-
range
public ValueRange range(TemporalField field)
Gets the range of valid values for the specified field.The range object expresses the minimum and maximum valid values for a field. This year is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.
If the field is a
ChronoFieldthen the query is implemented here. Thesupported fieldswill return appropriate range instances. All otherChronoFieldinstances will throw anUnsupportedTemporalTypeException.If the field is not a
ChronoField, then the result of this method is obtained by invokingTemporalField.rangeRefinedBy(TemporalAccessor)passingthisas the argument. Whether the range can be obtained is determined by the field.- Specified by:
rangein interfaceTemporalAccessor- Parameters:
field- the field to query the range for, not null- Returns:
- the range of valid values for the field, not null
- Throws:
DateTimeException- if the range for the field cannot be obtainedUnsupportedTemporalTypeException- if the field is not supported
-
get
public int get(TemporalField field)
Gets the value of the specified field from this year as anint.This queries this year for the value of the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a
ChronoFieldthen the query is implemented here. Thesupported fieldswill return valid values based on this year. All otherChronoFieldinstances will throw anUnsupportedTemporalTypeException.If the field is not a
ChronoField, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)passingthisas the argument. Whether the value can be obtained, and what the value represents, is determined by the field.- Specified by:
getin interfaceTemporalAccessor- Parameters:
field- the field to get, not null- Returns:
- the value for the field
- Throws:
DateTimeException- if a value for the field cannot be obtained or the value is outside the range of valid values for the fieldUnsupportedTemporalTypeException- if the field is not supported or the range of values exceeds anintArithmeticException- if numeric overflow occurs
-
getLong
public long getLong(TemporalField field)
Gets the value of the specified field from this year as along.This queries this year for the value of the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a
ChronoFieldthen the query is implemented here. Thesupported fieldswill return valid values based on this year. All otherChronoFieldinstances will throw anUnsupportedTemporalTypeException.If the field is not a
ChronoField, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)passingthisas the argument. Whether the value can be obtained, and what the value represents, is determined by the field.- Specified by:
getLongin interfaceTemporalAccessor- Parameters:
field- the field to get, not null- Returns:
- the value for the field
- Throws:
DateTimeException- if a value for the field cannot be obtainedUnsupportedTemporalTypeException- if the field is not supportedArithmeticException- if numeric overflow occurs
-
isLeap
public boolean isLeap()
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.This method applies the current rules for leap years across the whole time-line. In general, a year is a leap year if it is divisible by four without remainder. However, years divisible by 100, are not leap years, with the exception of years divisible by 400 which are.
For example, 1904 is a leap year it is divisible by 4. 1900 was not a leap year as it is divisible by 100, however 2000 was a leap year as it is divisible by 400.
The calculation is proleptic - applying the same rules into the far future and far past. This is historically inaccurate, but is correct for the ISO-8601 standard.
- Returns:
- true if the year is leap, false otherwise
-
isValidMonthDay
public boolean isValidMonthDay(MonthDay monthDay)
Checks if the month-day is valid for this year.This method checks whether this year and the input month and day form a valid date.
- Parameters:
monthDay- the month-day to validate, null returns false- Returns:
- true if the month and day are valid for this year
-
length
public int length()
Gets the length of this year in days.- Returns:
- the length of this year in days, 365 or 366
-
with
public Year with(TemporalAdjuster adjuster)
Returns an adjusted copy of this year.This returns a
Year, based on this one, with the year adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.The result of this method is obtained by invoking the
TemporalAdjuster.adjustInto(Temporal)method on the specified adjuster passingthisas the argument.This instance is immutable and unaffected by this method call.
- Specified by:
within interfaceTemporal- Parameters:
adjuster- the adjuster to use, not null- Returns:
- a
Yearbased onthiswith the adjustment made, not null - Throws:
DateTimeException- if the adjustment cannot be madeArithmeticException- if numeric overflow occurs
-
with
public Year with(TemporalField field, long newValue)
Returns a copy of this year with the specified field set to a new value.This returns a
Year, based on this one, with the value for the specified field changed. If it is not possible to set the value, because the field is not supported or for some other reason, an exception is thrown.If the field is a
ChronoFieldthen the adjustment is implemented here. The supported fields behave as follows:YEAR_OF_ERA- Returns aYearwith the specified year-of-era The era will be unchanged.YEAR- Returns aYearwith the specified year. This completely replaces the date and is equivalent toof(int).ERA- Returns aYearwith the specified era. The year-of-era will be unchanged.
In all cases, if the new value is outside the valid range of values for the field then a
DateTimeExceptionwill be thrown.All other
ChronoFieldinstances will throw anUnsupportedTemporalTypeException.If the field is not a
ChronoField, then the result of this method is obtained by invokingTemporalField.adjustInto(Temporal, long)passingthisas the argument. In this case, the field determines whether and how to adjust the instant.This instance is immutable and unaffected by this method call.
- Specified by:
within interfaceTemporal- Parameters:
field- the field to set in the result, not nullnewValue- the new value of the field in the result- Returns:
- a
Yearbased onthiswith the specified field set, not null - Throws:
DateTimeException- if the field cannot be setUnsupportedTemporalTypeException- if the field is not supportedArithmeticException- if numeric overflow occurs
-
plus
public Year plus(TemporalAmount amountToAdd)
Returns a copy of this year with the specified amount added.This returns a
Year, based on this one, with the specified amount added. The amount is typicallyPeriodbut may be any other type implementing theTemporalAmountinterface.The calculation is delegated to the amount object by calling
TemporalAmount.addTo(Temporal). The amount implementation is free to implement the addition in any way it wishes, however it typically calls back toplus(long, TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully added.This instance is immutable and unaffected by this method call.
- Specified by:
plusin interfaceTemporal- Parameters:
amountToAdd- the amount to add, not null- Returns:
- a
Yearbased on this year with the addition made, not null - Throws:
DateTimeException- if the addition cannot be madeArithmeticException- if numeric overflow occurs
-
plus
public Year plus(long amountToAdd, TemporalUnit unit)
Returns a copy of this year with the specified amount added.This returns a
Year, based on this one, with the amount in terms of the unit added. If it is not possible to add the amount, because the unit is not supported or for some other reason, an exception is thrown.If the field is a
ChronoUnitthen the addition is implemented here. The supported fields behave as follows:YEARS- Returns aYearwith the specified number of years added. This is equivalent toplusYears(long).DECADES- Returns aYearwith the specified number of decades added. This is equivalent to callingplusYears(long)with the amount multiplied by 10.CENTURIES- Returns aYearwith the specified number of centuries added. This is equivalent to callingplusYears(long)with the amount multiplied by 100.MILLENNIA- Returns aYearwith the specified number of millennia added. This is equivalent to callingplusYears(long)with the amount multiplied by 1,000.ERAS- Returns aYearwith the specified number of eras added. Only two eras are supported so the amount must be one, zero or minus one. If the amount is non-zero then the year is changed such that the year-of-era is unchanged.
All other
ChronoUnitinstances will throw anUnsupportedTemporalTypeException.If the field is not a
ChronoUnit, then the result of this method is obtained by invokingTemporalUnit.addTo(Temporal, long)passingthisas the argument. In this case, the unit determines whether and how to perform the addition.This instance is immutable and unaffected by this method call.
- Specified by:
plusin interfaceTemporal- Parameters:
amountToAdd- the amount of the unit to add to the result, may be negativeunit- the unit of the amount to add, not null- Returns:
- a
Yearbased on this year with the specified amount added, not null - Throws:
DateTimeException- if the addition cannot be madeUnsupportedTemporalTypeException- if the unit is not supportedArithmeticException- if numeric overflow occurs
-
plusYears
public Year plusYears(long yearsToAdd)
Returns a copy of thisYearwith the specified number of years added.This instance is immutable and unaffected by this method call.
- Parameters:
yearsToAdd- the years to add, may be negative- Returns:
- a
Yearbased on this year with the years added, not null - Throws:
DateTimeException- if the result exceeds the supported range
-
minus
public Year minus(TemporalAmount amountToSubtract)
Returns a copy of this year with the specified amount subtracted.This returns a
Year, based on this one, with the specified amount subtracted. The amount is typicallyPeriodbut may be any other type implementing theTemporalAmountinterface.The calculation is delegated to the amount object by calling
TemporalAmount.subtractFrom(Temporal). The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back tominus(long, TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully subtracted.This instance is immutable and unaffected by this method call.
- Specified by:
minusin interfaceTemporal- Parameters:
amountToSubtract- the amount to subtract, not null- Returns:
- a
Yearbased on this year with the subtraction made, not null - Throws:
DateTimeException- if the subtraction cannot be madeArithmeticException- if numeric overflow occurs
-
minus
public Year minus(long amountToSubtract, TemporalUnit unit)
Returns a copy of this year with the specified amount subtracted.This returns a
Year, based on this one, with the amount in terms of the unit subtracted. If it is not possible to subtract the amount, because the unit is not supported or for some other reason, an exception is thrown.This method is equivalent to
plus(long, TemporalUnit)with the amount negated. See that method for a full description of how addition, and thus subtraction, works.This instance is immutable and unaffected by this method call.
- Specified by:
minusin interfaceTemporal- Parameters:
amountToSubtract- the amount of the unit to subtract from the result, may be negativeunit- the unit of the amount to subtract, not null- Returns:
- a
Yearbased on this year with the specified amount subtracted, not null - Throws:
DateTimeException- if the subtraction cannot be madeUnsupportedTemporalTypeException- if the unit is not supportedArithmeticException- if numeric overflow occurs
-
minusYears
public Year minusYears(long yearsToSubtract)
Returns a copy of thisYearwith the specified number of years subtracted.This instance is immutable and unaffected by this method call.
- Parameters:
yearsToSubtract- the years to subtract, may be negative- Returns:
- a
Yearbased on this year with the year subtracted, not null - Throws:
DateTimeException- if the result exceeds the supported range
-
query
public <R> R query(TemporalQuery<R> query)
Queries this year using the specified query.This queries this year using the specified query strategy object. The
TemporalQueryobject defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.The result of this method is obtained by invoking the
TemporalQuery.queryFrom(TemporalAccessor)method on the specified query passingthisas the argument.- Specified by:
queryin interfaceTemporalAccessor- Type Parameters:
R- the type of the result- Parameters:
query- the query to invoke, not null- Returns:
- the query result, null may be returned (defined by the query)
- Throws:
DateTimeException- if unable to query (defined by the query)ArithmeticException- if numeric overflow occurs (defined by the query)
-
adjustInto
public Temporal adjustInto(Temporal temporal)
Adjusts the specified temporal object to have this year.This returns a temporal object of the same observable type as the input with the year changed to be the same as this.
The adjustment is equivalent to using
Temporal.with(TemporalField, long)passingChronoField.YEARas the field. If the specified temporal object does not use the ISO calendar system then aDateTimeExceptionis thrown.In most cases, it is clearer to reverse the calling pattern by using
Temporal.with(TemporalAdjuster):// these two lines are equivalent, but the second approach is recommended temporal = thisYear.adjustInto(temporal); temporal = temporal.with(thisYear);
This instance is immutable and unaffected by this method call.
- Specified by:
adjustIntoin interfaceTemporalAdjuster- Parameters:
temporal- the target object to be adjusted, not null- Returns:
- the adjusted object, not null
- Throws:
DateTimeException- if unable to make the adjustmentArithmeticException- if numeric overflow occurs
-
until
public long until(Temporal endExclusive, TemporalUnit unit)
Calculates the amount of time until another year in terms of the specified unit.This calculates the amount of time between two
Yearobjects in terms of a singleTemporalUnit. The start and end points arethisand the specified year. The result will be negative if the end is before the start. TheTemporalpassed to this method is converted to aYearusingfrom(TemporalAccessor). For example, the amount in decades between two year can be calculated usingstartYear.until(endYear, DECADES).The calculation returns a whole number, representing the number of complete units between the two years. For example, the amount in decades between 2012 and 2031 will only be one decade as it is one year short of two decades.
There are two equivalent ways of using this method. The first is to invoke this method. The second is to use
TemporalUnit.between(Temporal, Temporal):// these two lines are equivalent amount = start.until(end, YEARS); amount = YEARS.between(start, end);
The choice should be made based on which makes the code more readable.The calculation is implemented in this method for
ChronoUnit. The unitsYEARS,DECADES,CENTURIES,MILLENNIAandERASare supported. OtherChronoUnitvalues will throw an exception.If the unit is not a
ChronoUnit, then the result of this method is obtained by invokingTemporalUnit.between(Temporal, Temporal)passingthisas the first argument and the converted input temporal as the second argument.This instance is immutable and unaffected by this method call.
- Specified by:
untilin interfaceTemporal- Parameters:
endExclusive- the end date, exclusive, which is converted to aYear, not nullunit- the unit to measure the amount in, not null- Returns:
- the amount of time between this year and the end year
- Throws:
DateTimeException- if the amount cannot be calculated, or the end temporal cannot be converted to aYearUnsupportedTemporalTypeException- if the unit is not supportedArithmeticException- if numeric overflow occurs
-
format
public String format(DateTimeFormatter formatter)
Formats this year using the specified formatter.This year will be passed to the formatter to produce a string.
- Parameters:
formatter- the formatter to use, not null- Returns:
- the formatted year string, not null
- Throws:
DateTimeException- if an error occurs during printing
-
atDay
public LocalDate atDay(int dayOfYear)
Combines this year with a day-of-year to create aLocalDate.This returns a
LocalDateformed from this year and the specified day-of-year.The day-of-year value 366 is only valid in a leap year.
- Parameters:
dayOfYear- the day-of-year to use, from 1 to 365-366- Returns:
- the local date formed from this year and the specified date of year, not null
- Throws:
DateTimeException- if the day of year is zero or less, 366 or greater or equal to 366 and this is not a leap year
-
atMonth
public YearMonth atMonth(Month month)
Combines this year with a month to create aYearMonth.This returns a
YearMonthformed from this year and the specified month. All possible combinations of year and month are valid.This method can be used as part of a chain to produce a date:
LocalDate date = year.atMonth(month).atDay(day);
- Parameters:
month- the month-of-year to use, not null- Returns:
- the year-month formed from this year and the specified month, not null
-
atMonth
public YearMonth atMonth(int month)
Combines this year with a month to create aYearMonth.This returns a
YearMonthformed from this year and the specified month. All possible combinations of year and month are valid.This method can be used as part of a chain to produce a date:
LocalDate date = year.atMonth(month).atDay(day);
- Parameters:
month- the month-of-year to use, from 1 (January) to 12 (December)- Returns:
- the year-month formed from this year and the specified month, not null
- Throws:
DateTimeException- if the month is invalid
-
atMonthDay
public LocalDate atMonthDay(MonthDay monthDay)
Combines this year with a month-day to create aLocalDate.This returns a
LocalDateformed from this year and the specified month-day.A month-day of February 29th will be adjusted to February 28th in the resulting date if the year is not a leap year.
- Parameters:
monthDay- the month-day to use, not null- Returns:
- the local date formed from this year and the specified month-day, not null
-
compareTo
public int compareTo(Year other)
Compares this year to another year.The comparison is based on the value of the year. It is "consistent with equals", as defined by
Comparable.- Specified by:
compareToin interfaceComparable<Year>- Parameters:
other- the other year to compare to, not null- Returns:
- the comparator value, negative if less, positive if greater
-
isAfter
public boolean isAfter(Year other)
Checks if this year is after the specified year.- Parameters:
other- the other year to compare to, not null- Returns:
- true if this is after the specified year
-
isBefore
public boolean isBefore(Year other)
Checks if this year is before the specified year.- Parameters:
other- the other year to compare to, not null- Returns:
- true if this point is before the specified year
-
equals
public boolean equals(Object obj)
Checks if this year is equal to another year.The comparison is based on the time-line position of the years.
- Overrides:
equalsin classObject- Parameters:
obj- the object to check, null returns false- Returns:
- true if this is equal to the other year
- See Also:
Object.hashCode()
-
hashCode
public int hashCode()
A hash code for this year.- Overrides:
hashCodein classObject- Returns:
- a suitable hash code
- See Also:
Object.equals(java.lang.Object)
-
-