- java.lang.Object
-
- org.threeten.extra.YearHalf
-
- All Implemented Interfaces:
Serializable
,Comparable<YearHalf>
,Temporal
,TemporalAccessor
,TemporalAdjuster
public final class YearHalf extends Object implements Temporal, TemporalAdjuster, Comparable<YearHalf>, Serializable
A year-half in the ISO-8601 calendar system, such as2007-H2
.YearHalf
is an immutable date-time object that represents the combination of a year and a half-year. Any field that can be derived from a year and a half-year can be obtained. A half is defined byHalf
- H1 and H2. H1 is January to June, H2 is July to December.This class does not store or represent a day, time or time-zone. For example, the value "2nd half 2007" can be stored in a
YearHalf
.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. Note that the ISO-8601 standard does not define or refer to halves.
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:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Temporal
adjustInto(Temporal temporal)
Adjusts the specified temporal object to have this year-half.LocalDate
atDay(int dayOfHalf)
Combines this year-half with a day-of-half to create aLocalDate
.LocalDate
atEndOfHalf()
Returns aLocalDate
at the end of the half.int
compareTo(YearHalf other)
Compares this year-half to anotherboolean
equals(Object obj)
Checks if this year-half is equal to another year-half.String
format(DateTimeFormatter formatter)
Formats this year-half using the specified formatter.static YearHalf
from(TemporalAccessor temporal)
Obtains an instance ofYearHalf
from a temporal object.int
get(TemporalField field)
Gets the value of the specified field from this year-half as anint
.Half
getHalf()
Gets the half-of-year field using theHalf
enum.int
getHalfValue()
Gets the half-of-year field from 1 to 2.long
getLong(TemporalField field)
Gets the value of the specified field from this year-half as along
.int
getYear()
Gets the year field.Stream<YearHalf>
halvesUntil(YearHalf endExclusive)
Returns a sequential ordered stream of year-half.int
hashCode()
A hash code for this year-half.boolean
isAfter(YearHalf other)
Is this year-half after the specified year-half.boolean
isBefore(YearHalf other)
Is this year-half before the specified year-half.boolean
isLeapYear()
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.boolean
isSupported(TemporalField field)
Checks if the specified field is supported.boolean
isSupported(TemporalUnit unit)
Checks if the specified unit is supported.boolean
isValidDay(int dayOfHalf)
Checks if the day-of-half is valid for this year-half.int
lengthOfHalf()
Returns the length of the half, taking account of the year.int
lengthOfYear()
Returns the length of the year.YearHalf
minus(long amountToSubtract, TemporalUnit unit)
Returns a copy of this year-half with the specified amount subtracted.YearHalf
minus(TemporalAmount amountToSubtract)
Returns a copy of this year-half with the specified amount subtracted.YearHalf
minusHalves(long halvesToSubtract)
Returns a copy of this year-half with the specified period in halves subtracted.YearHalf
minusYears(long yearsToSubtract)
Returns a copy of this year-half with the specified period in years subtracted.static YearHalf
now()
Obtains the current year-half from the system clock in the default time-zone.static YearHalf
now(Clock clock)
Obtains the current year-half from the specified clock.static YearHalf
now(ZoneId zone)
Obtains the current year-half from the system clock in the specified time-zone.static YearHalf
of(int year, int half)
Obtains an instance ofYearHalf
from a year and half.static YearHalf
of(int year, Half half)
Obtains an instance ofYearHalf
from a year and half.static YearHalf
of(Year year, int half)
Obtains an instance ofYearHalf
from a year and half.static YearHalf
of(Year year, Half half)
Obtains an instance ofYearHalf
from a year and half.static YearHalf
parse(CharSequence text)
Obtains an instance ofYearHalf
from a text string such as2007-H2
.static YearHalf
parse(CharSequence text, DateTimeFormatter formatter)
Obtains an instance ofYearHalf
from a text string using a specific formatter.YearHalf
plus(long amountToAdd, TemporalUnit unit)
Returns a copy of this year-half with the specified amount added.YearHalf
plus(TemporalAmount amountToAdd)
Returns a copy of this year-half with the specified amount added.YearHalf
plusHalves(long halvesToAdd)
Returns a copy of this year-half with the specified period in halves added.YearHalf
plusYears(long yearsToAdd)
Returns a copy of this year-half with the specified period in years added.<R> R
query(TemporalQuery<R> query)
Queries this year-half using the specified query.ValueRange
range(TemporalField field)
Gets the range of valid values for the specified field.String
toString()
Outputs this year-half as aString
, such as2007-H2
.long
until(Temporal endExclusive, TemporalUnit unit)
Calculates the amount of time until another year-half in terms of the specified unit.YearHalf
with(TemporalAdjuster adjuster)
Returns an adjusted copy of this year-half.YearHalf
with(TemporalField field, long newValue)
Returns a copy of this year-half with the specified field set to a new value.YearHalf
withHalf(int half)
Returns a copy of thisYearHalf
with the half-of-year altered.YearHalf
withYear(int year)
Returns a copy of thisYearHalf
with the year altered.
-
-
-
Method Detail
-
now
public static YearHalf now()
Obtains the current year-half from the system clock in the default time-zone.This will query the
system clock
in the default time-zone to obtain the current year-half. The zone and offset will be set based on the time-zone in the clock.Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
- Returns:
- the current year-half using the system clock and default time-zone, not null
-
now
public static YearHalf now(ZoneId zone)
Obtains the current year-half from the system clock in the specified time-zone.This will query the
system clock
to obtain the current year-half. 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-half using the system clock, not null
-
now
public static YearHalf now(Clock clock)
Obtains the current year-half from the specified clock.This will query the specified clock to obtain the current year-half. 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-half, not null
-
of
public static YearHalf of(Year year, Half half)
Obtains an instance ofYearHalf
from a year and half.- Parameters:
year
- the year to represent, not nullhalf
- the half-of-year to represent, not null- Returns:
- the year-half, not null
-
of
public static YearHalf of(Year year, int half)
Obtains an instance ofYearHalf
from a year and half.- Parameters:
year
- the year to represent, not nullhalf
- the half-of-year to represent, from 1 to 2- Returns:
- the year-half, not null
- Throws:
DateTimeException
- if the half value is invalid
-
of
public static YearHalf of(int year, Half half)
Obtains an instance ofYearHalf
from a year and half.- Parameters:
year
- the year to represent, from MIN_YEAR to MAX_YEARhalf
- the half-of-year to represent, not null- Returns:
- the year-half, not null
- Throws:
DateTimeException
- if the year value is invalid
-
of
public static YearHalf of(int year, int half)
Obtains an instance ofYearHalf
from a year and half.- Parameters:
year
- the year to represent, from MIN_YEAR to MAX_YEARhalf
- the half-of-year to represent, from 1 to 2- Returns:
- the year-half, not null
- Throws:
DateTimeException
- if either field value is invalid
-
from
public static YearHalf from(TemporalAccessor temporal)
Obtains an instance ofYearHalf
from a temporal object.This obtains a year-half based on the specified temporal. A
TemporalAccessor
represents an arbitrary set of date and time information, which this factory converts to an instance ofYearHalf
.The conversion extracts the
YEAR
andHALF_OF_YEAR
fields. 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
TemporalQuery
allowing it to be used in queries via method reference,YearHalf::from
.- Parameters:
temporal
- the temporal object to convert, not null- Returns:
- the year-half, not null
- Throws:
DateTimeException
- if unable to convert to aYearHalf
-
parse
public static YearHalf parse(CharSequence text)
Obtains an instance ofYearHalf
from a text string such as2007-H2
.The string must represent a valid year-half. The format must be
uuuu-'Q'Q
where the 'Q' is case insensitive. 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-H2", not null- Returns:
- the parsed year-half, not null
- Throws:
DateTimeParseException
- if the text cannot be parsed
-
parse
public static YearHalf parse(CharSequence text, DateTimeFormatter formatter)
Obtains an instance ofYearHalf
from a text string using a specific formatter.The text is parsed using the formatter, returning a year-half.
- Parameters:
text
- the text to parse, not nullformatter
- the formatter to use, not null- Returns:
- the parsed year-half, not null
- Throws:
DateTimeParseException
- if the text cannot be parsed
-
isSupported
public boolean isSupported(TemporalField field)
Checks if the specified field is supported.This checks if this year-half can be queried for the specified field. If false, then calling the
range
,get
andwith(TemporalField, long)
methods will throw an exception.If the field is a
ChronoField
then the query is implemented here. The supported fields are:HALF_OF_YEAR
YEAR_OF_ERA
YEAR
ERA
ChronoField
instances will return false.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.isSupportedBy(TemporalAccessor)
passingthis
as the argument. Whether the field is supported is determined by the field.- Specified by:
isSupported
in interfaceTemporalAccessor
- Parameters:
field
- the field to check, null returns false- Returns:
- true if the field is supported on this year-half, 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-half. If false, then calling the
plus(long, TemporalUnit)
andminus
methods will throw an exception.If the unit is a
ChronoUnit
then the query is implemented here. The supported units are:HALF_YEARS
YEARS
DECADES
CENTURIES
MILLENNIA
ERAS
ChronoUnit
instances will return false.If the unit is not a
ChronoUnit
, then the result of this method is obtained by invokingTemporalUnit.isSupportedBy(Temporal)
passingthis
as the argument. Whether the unit is supported is determined by the unit.- Specified by:
isSupported
in 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-half 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
ChronoField
then the query is implemented here. Thesupported fields
will return appropriate range instances. All otherChronoField
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.rangeRefinedBy(TemporalAccessor)
passingthis
as the argument. Whether the range can be obtained is determined by the field.- Specified by:
range
in 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-half as anint
.This queries this year-half for the value for 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
ChronoField
then the query is implemented here. Thesupported fields
will return valid values based on this year-half,. All otherChronoField
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)
passingthis
as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.- Specified by:
get
in 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 anint
ArithmeticException
- if numeric overflow occurs
-
getLong
public long getLong(TemporalField field)
Gets the value of the specified field from this year-half as along
.This queries this year-half for the value for 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
ChronoField
then the query is implemented here. Thesupported fields
will return valid values based on this year-half. All otherChronoField
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)
passingthis
as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.- Specified by:
getLong
in 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
-
getYear
public int getYear()
Gets the year field.This method returns the primitive
int
value for the year.The year returned by this method is proleptic as per
get(YEAR)
.- Returns:
- the year, from MIN_YEAR to MAX_YEAR
-
getHalfValue
public int getHalfValue()
Gets the half-of-year field from 1 to 2.This method returns the half as an
int
from 1 to 2. Application code is frequently clearer if the enumHalf
is used by callinggetHalf()
.- Returns:
- the half-of-year, from 1 to 2
- See Also:
getHalf()
-
getHalf
public Half getHalf()
Gets the half-of-year field using theHalf
enum.This method returns the enum
Half
for the half. This avoids confusion as to whatint
values mean. If you need access to the primitiveint
value then the enum provides theint value
.- Returns:
- the half-of-year, not null
- See Also:
getHalfValue()
-
isLeapYear
public boolean isLeapYear()
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
-
isValidDay
public boolean isValidDay(int dayOfHalf)
Checks if the day-of-half is valid for this year-half.This method checks whether this year and half and the input day form a valid date.
- Parameters:
dayOfHalf
- the day-of-half to validate, from 1 to 181, 182 or 184, invalid value returns false- Returns:
- true if the day is valid for this year-half
-
lengthOfHalf
public int lengthOfHalf()
Returns the length of the half, taking account of the year.This returns the length of the half in days.
- Returns:
- the length of the half in days, 181, 182 or 184
-
lengthOfYear
public int lengthOfYear()
Returns the length of the year.This returns the length of the year in days, either 365 or 366.
- Returns:
- 366 if the year is leap, 365 otherwise
-
with
public YearHalf with(TemporalAdjuster adjuster)
Returns an adjusted copy of this year-half.This returns a
YearHalf
based on this one, with the year-half adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the year-half to the next half that Halley's comet will pass the Earth.
The result of this method is obtained by invoking the
TemporalAdjuster.adjustInto(Temporal)
method on the specified adjuster passingthis
as the argument.This instance is immutable and unaffected by this method call.
- Specified by:
with
in interfaceTemporal
- Parameters:
adjuster
- the adjuster to use, not null- Returns:
- a
YearHalf
based onthis
with the adjustment made, not null - Throws:
DateTimeException
- if the adjustment cannot be madeArithmeticException
- if numeric overflow occurs
-
with
public YearHalf with(TemporalField field, long newValue)
Returns a copy of this year-half with the specified field set to a new value.This returns a
YearHalf
based on this one, with the value for the specified field changed. This can be used to change any supported field, such as the year or half. 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
ChronoField
then the adjustment is implemented here. The supported fields behave as follows:HALF_OF_YEAR
- Returns aYearHalf
with the specified half-of-year. The year will be unchanged.YEAR_OF_ERA
- Returns aYearHalf
with the specified year-of-era The half and era will be unchanged.YEAR
- Returns aYearHalf
with the specified year. The half will be unchanged.ERA
- Returns aYearHalf
with the specified era. The half and 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
DateTimeException
will be thrown.All other
ChronoField
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.adjustInto(Temporal, long)
passingthis
as 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:
with
in interfaceTemporal
- Parameters:
field
- the field to set in the result, not nullnewValue
- the new value of the field in the result- Returns:
- a
YearHalf
based onthis
with the specified field set, not null - Throws:
DateTimeException
- if the field cannot be setUnsupportedTemporalTypeException
- if the field is not supportedArithmeticException
- if numeric overflow occurs
-
withYear
public YearHalf withYear(int year)
Returns a copy of thisYearHalf
with the year altered.This instance is immutable and unaffected by this method call.
- Parameters:
year
- the year to set in the returned year-half, from MIN_YEAR to MAX_YEAR- Returns:
- a
YearHalf
based on this year-half with the requested year, not null - Throws:
DateTimeException
- if the year value is invalid
-
withHalf
public YearHalf withHalf(int half)
Returns a copy of thisYearHalf
with the half-of-year altered.This instance is immutable and unaffected by this method call.
- Parameters:
half
- the half-of-year to set in the returned year-half, from 1 to 2- Returns:
- a
YearHalf
based on this year-half with the requested half, not null - Throws:
DateTimeException
- if the half-of-year value is invalid
-
plus
public YearHalf plus(TemporalAmount amountToAdd)
Returns a copy of this year-half with the specified amount added.This returns a
YearHalf
based on this one, with the specified amount added. The amount is typicallyPeriod
but may be any other type implementing theTemporalAmount
interface.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:
plus
in interfaceTemporal
- Parameters:
amountToAdd
- the amount to add, not null- Returns:
- a
YearHalf
based on this year-half with the addition made, not null - Throws:
DateTimeException
- if the addition cannot be madeArithmeticException
- if numeric overflow occurs
-
plus
public YearHalf plus(long amountToAdd, TemporalUnit unit)
Returns a copy of this year-half with the specified amount added.This returns a
YearHalf
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
ChronoUnit
then the addition is implemented here. The supported fields behave as follows:HALF_YEARS
- Returns aYearHalf
with the specified number of halves added. This is equivalent toplusHalves(long)
.YEARS
- Returns aYearHalf
with the specified number of years added. This is equivalent toplusYears(long)
.DECADES
- Returns aYearHalf
with the specified number of decades added. This is equivalent to callingplusYears(long)
with the amount multiplied by 10.CENTURIES
- Returns aYearHalf
with the specified number of centuries added. This is equivalent to callingplusYears(long)
with the amount multiplied by 100.MILLENNIA
- Returns aYearHalf
with the specified number of millennia added. This is equivalent to callingplusYears(long)
with the amount multiplied by 1,000.ERAS
- Returns aYearHalf
with 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
ChronoUnit
instances will throw anUnsupportedTemporalTypeException
.If the field is not a
ChronoUnit
, then the result of this method is obtained by invokingTemporalUnit.addTo(Temporal, long)
passingthis
as 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:
plus
in 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
YearHalf
based on this year-half 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 YearHalf plusYears(long yearsToAdd)
Returns a copy of this year-half with the specified period in years added.This instance is immutable and unaffected by this method call.
- Parameters:
yearsToAdd
- the years to add, may be negative- Returns:
- a
YearHalf
based on this year-half with the years added, not null - Throws:
DateTimeException
- if the result exceeds the supported range
-
plusHalves
public YearHalf plusHalves(long halvesToAdd)
Returns a copy of this year-half with the specified period in halves added.This instance is immutable and unaffected by this method call.
- Parameters:
halvesToAdd
- the halves to add, may be negative- Returns:
- a
YearHalf
based on this year-half with the halves added, not null - Throws:
DateTimeException
- if the result exceeds the supported range
-
minus
public YearHalf minus(TemporalAmount amountToSubtract)
Returns a copy of this year-half with the specified amount subtracted.This returns a
YearHalf
based on this one, with the specified amount subtracted. The amount is typicallyPeriod
but may be any other type implementing theTemporalAmount
interface.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:
minus
in interfaceTemporal
- Parameters:
amountToSubtract
- the amount to subtract, not null- Returns:
- a
YearHalf
based on this year-half with the subtraction made, not null - Throws:
DateTimeException
- if the subtraction cannot be madeArithmeticException
- if numeric overflow occurs
-
minus
public YearHalf minus(long amountToSubtract, TemporalUnit unit)
Returns a copy of this year-half with the specified amount subtracted.This returns a
YearHalf
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:
minus
in 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
YearHalf
based on this year-half 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 YearHalf minusYears(long yearsToSubtract)
Returns a copy of this year-half with the specified period in years subtracted.This instance is immutable and unaffected by this method call.
- Parameters:
yearsToSubtract
- the years to subtract, may be negative- Returns:
- a
YearHalf
based on this year-half with the years subtracted, not null - Throws:
DateTimeException
- if the result exceeds the supported range
-
minusHalves
public YearHalf minusHalves(long halvesToSubtract)
Returns a copy of this year-half with the specified period in halves subtracted.This instance is immutable and unaffected by this method call.
- Parameters:
halvesToSubtract
- the halves to subtract, may be negative- Returns:
- a
YearHalf
based on this year-half with the halves subtracted, not null - Throws:
DateTimeException
- if the result exceeds the supported range
-
query
public <R> R query(TemporalQuery<R> query)
Queries this year-half using the specified query.This queries this year-half using the specified query strategy object. The
TemporalQuery
object 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 passingthis
as the argument.- Specified by:
query
in 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-half.This returns a temporal object of the same observable type as the input with the year and half changed to be the same as this.
The adjustment is equivalent to using
Temporal.plus(long, TemporalUnit)
passing the number of halves to adjust by. If the specified temporal object does not use the ISO calendar system then aDateTimeException
is 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 = thisYearHalf.adjustInto(temporal); temporal = temporal.with(thisYearHalf);
This instance is immutable and unaffected by this method call.
- Specified by:
adjustInto
in 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-half in terms of the specified unit.This calculates the amount of time between two
YearHalf
objects in terms of a singleTemporalUnit
. The start and end points arethis
and the specified year-half. The result will be negative if the end is before the start. TheTemporal
passed to this method is converted to aYearHalf
usingfrom(TemporalAccessor)
. For example, the period in years between two year-halves can be calculated usingstartYearHalf.until(endYearHalf, YEARS)
.The calculation returns a whole number, representing the number of complete units between the two year-halves. For example, the period in decades between 2012-H2 and 2032-H1 will only be one decade as it is one half 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, HALF_YEARS); amount = HALF_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 unitsHALF_YEARS
,YEARS
,DECADES
,CENTURIES
,MILLENNIA
andERAS
are supported. OtherChronoUnit
values will throw an exception.If the unit is not a
ChronoUnit
, then the result of this method is obtained by invokingTemporalUnit.between(Temporal, Temporal)
passingthis
as the first argument and the converted input temporal as the second argument.This instance is immutable and unaffected by this method call.
- Specified by:
until
in interfaceTemporal
- Parameters:
endExclusive
- the end date, exclusive, which is converted to aYearHalf
, not nullunit
- the unit to measure the amount in, not null- Returns:
- the amount of time between this year-half and the end year-half
- Throws:
DateTimeException
- if the amount cannot be calculated, or the end temporal cannot be converted to aYearHalf
UnsupportedTemporalTypeException
- if the unit is not supportedArithmeticException
- if numeric overflow occurs
-
halvesUntil
public Stream<YearHalf> halvesUntil(YearHalf endExclusive)
Returns a sequential ordered stream of year-half. The returned stream starts from this year-half (inclusive) and goes toendExclusive
(exclusive) by an incremental step of 1HALF_YEARS
.This instance is immutable and unaffected by this method call.
- Parameters:
endExclusive
- the end year-half, exclusive, not null- Returns:
- a sequential
Stream
for the range ofYearHalf
values - Throws:
IllegalArgumentException
- if end year-half is before this year-half
-
format
public String format(DateTimeFormatter formatter)
Formats this year-half using the specified formatter.This year-half will be passed to the formatter to produce a string.
- Parameters:
formatter
- the formatter to use, not null- Returns:
- the formatted year-half string, not null
- Throws:
DateTimeException
- if an error occurs during printing
-
atDay
public LocalDate atDay(int dayOfHalf)
Combines this year-half with a day-of-half to create aLocalDate
.This returns a
LocalDate
formed from this year-half and the specified day-of-half.The day-of-half value must be valid for the year-half.
This method can be used as part of a chain to produce a date:
LocalDate date = yearHalf.atDay(day);
- Parameters:
dayOfHalf
- the day-of-half to use, from 1 to 184- Returns:
- the date formed from this year-half and the specified day, not null
- Throws:
DateTimeException
- if the day is invalid for the year-half- See Also:
isValidDay(int)
-
atEndOfHalf
public LocalDate atEndOfHalf()
Returns aLocalDate
at the end of the half.This returns a
LocalDate
based on this year-half. The day-of-half is set to the last valid day of the half, taking into account leap years.This method can be used as part of a chain to produce a date:
LocalDate date = year.atHalf(half).atEndOfHalf();
- Returns:
- the last valid date of this year-half, not null
-
compareTo
public int compareTo(YearHalf other)
Compares this year-half to anotherThe comparison is based first on the value of the year, then on the value of the half. It is "consistent with equals", as defined by
Comparable
.- Specified by:
compareTo
in interfaceComparable<YearHalf>
- Parameters:
other
- the other year-half to compare to, not null- Returns:
- the comparator value, negative if less, positive if greater
-
isAfter
public boolean isAfter(YearHalf other)
Is this year-half after the specified year-half.- Parameters:
other
- the other year-half to compare to, not null- Returns:
- true if this is after the specified year-half
-
isBefore
public boolean isBefore(YearHalf other)
Is this year-half before the specified year-half.- Parameters:
other
- the other year-half to compare to, not null- Returns:
- true if this point is before the specified year-half
-
equals
public boolean equals(Object obj)
Checks if this year-half is equal to another year-half.The comparison is based on the time-line position of the year-halves.
-
hashCode
public int hashCode()
A hash code for this year-half.
-
-