Module org.threeten.extra

Package org.threeten.extra

Enum Half

java.lang.Object

java.lang.Enum<Half>

org.threeten.extra.Half

All Implemented Interfaces:

Serializable, Comparable<Half>, TemporalAccessor, TemporalAdjuster

public enum Half
extends Enum<Half>
implements TemporalAccessor, TemporalAdjuster

A half-of-year, such as 'H2'.

Half is an enum representing the 2 halves of the year - H1 and H2. These are defined as January to June and July to December.

The int value follows the half, from 1 (H1) to 2 (H2). It is recommended that applications use the enum rather than the int value to ensure code clarity.

Do not use ordinal() to obtain the numeric representation of Half. Use getValue() instead.

Implementation Requirements:

This is an immutable and thread-safe enum.

Enum Constant Summary

Enum Constants

Enum Constant	Description
H1	The singleton instance for the first half-of-year, from January to June.
H2	The singleton instance for the second half-of-year, from July to December.

Method Summary

Modifier and Type	Method	Description
Temporal	adjustInto(Temporal temporal)	Adjusts the specified temporal object to have this half-of-year.
Month	firstMonth()	Gets the first of the six months that this half refers to.
static Half	from(TemporalAccessor temporal)	Obtains an instance of Half from a temporal object.
int	get(TemporalField field)	Gets the value of the specified field from this half-of-year as an int.
String	getDisplayName(TextStyle style, Locale locale)	Gets the textual representation, such as 'H1' or '4th half'.
long	getLong(TemporalField field)	Gets the value of the specified field from this half-of-year as a long.
int	getValue()	Gets the half-of-year int value.
boolean	isSupported(TemporalField field)	Checks if the specified field is supported.
int	length(boolean leapYear)	Gets the length of this half in days.
Half	minus(long halves)	Returns the half that is the specified number of halves before this one.
static Half	of(int halfOfYear)	Obtains an instance of Half from an int value.
static Half	ofMonth(int monthOfYear)	Obtains an instance of Half from a month-of-year.
Half	plus(long halves)	Returns the half that is the specified number of halves after this one.
<R> R	query(TemporalQuery<R> query)	Queries this half-of-year using the specified query.
ValueRange	range(TemporalField field)	Gets the range of valid values for the specified field.
static Half	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Half[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

H1

public static final Half H1

The singleton instance for the first half-of-year, from January to June. This has the numeric value of 1.

H2

public static final Half H2

The singleton instance for the second half-of-year, from July to December. This has the numeric value of 2.

Method Detail

values

public static Half[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Half c : Half.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Half valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

of

public static Half of(int halfOfYear)

Obtains an instance of Half from an int value.

Half is an enum representing the 2 halves of the year. This factory allows the enum to be obtained from the int value. The int value follows the half, from 1 (H1) to 2 (H2).

Parameters:

halfOfYear - the half-of-year to represent, from 1 (H1) to 2 (H2)

Returns:

the half-of-year, not null

Throws:

DateTimeException - if the half-of-year is invalid

ofMonth

public static Half ofMonth(int monthOfYear)

Obtains an instance of Half from a month-of-year.

Half is an enum representing the 2 halves of the year. This factory allows the enum to be obtained from the Month value.

January to June are H1 and July to December are H2.

Parameters:

monthOfYear - the month-of-year to convert from, from 1 to 12

Returns:

the half-of-year, not null

Throws:

DateTimeException - if the month-of-year is invalid

from

public static Half from(TemporalAccessor temporal)

Obtains an instance of Half from a temporal object.

This obtains a half based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of Half.

The conversion extracts the HALF_OF_YEAR field. The extraction is only permitted if the temporal object has an ISO chronology, or can be converted to a LocalDate.

This method matches the signature of the functional interface TemporalQuery allowing it to be used in queries via method reference, Half::from.

Parameters:

temporal - the temporal-time object to convert, not null

Returns:

the half-of-year, not null

Throws:

DateTimeException - if unable to convert to a Half

getValue

public int getValue()

Gets the half-of-year int value.

The values are numbered following the ISO-8601 standard, from 1 (H1) to 2 (H2).

Returns:

the half-of-year, from 1 (H1) to 2 (H2)

getDisplayName

public String getDisplayName(TextStyle style,
                             Locale locale)

Gets the textual representation, such as 'H1' or '4th half'.

This returns the textual name used to identify the half-of-year, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

If no textual mapping is found then the numeric value is returned.

Parameters:

style - the length of the text required, not null

locale - the locale to use, not null

Returns:

the text value of the half-of-year, not null

isSupported

public boolean isSupported(TemporalField field)

Checks if the specified field is supported.

This checks if this half-of-year can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

If the field is HALF_OF_YEAR then this method returns true. All ChronoField instances will return false.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

Specified by:

isSupported in interface TemporalAccessor

Parameters:

field - the field to check, null returns false

Returns:

true if the field is supported on this half-of-year, 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 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 HALF_OF_YEAR then the range of the half-of-year, from 1 to 2, will be returned. All ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

Specified by:

range in interface TemporalAccessor

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 obtained

UnsupportedTemporalTypeException - if the field is not supported

get

public int get(TemporalField field)

Gets the value of the specified field from this half-of-year as an int.

This queries this 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 HALF_OF_YEAR then the value of the half-of-year, from 1 to 2, will be returned. All ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Specified by:

get in interface TemporalAccessor

Parameters:

field - the field to get, not null

Returns:

the value for the field, within the valid range of values

Throws:

DateTimeException - if a value for the field cannot be obtained or the value is outside the range of valid values for the field

UnsupportedTemporalTypeException - if the field is not supported or the range of values exceeds an int

ArithmeticException - if numeric overflow occurs

getLong

public long getLong(TemporalField field)

Gets the value of the specified field from this half-of-year as a long.

This queries this 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 HALF_OF_YEAR then the value of the half-of-year, from 1 to 2, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Specified by:

getLong in interface TemporalAccessor

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

UnsupportedTemporalTypeException - if the field is not supported

ArithmeticException - if numeric overflow occurs

plus

public Half plus(long halves)

Returns the half that is the specified number of halves after this one.

The calculation rolls around the end of the year from H2 to H1. The specified period may be negative.

This instance is immutable and unaffected by this method call.

Parameters:

halves - the halves to add, positive or negative

Returns:

the resulting half, not null

minus

public Half minus(long halves)

Returns the half that is the specified number of halves before this one.

The calculation rolls around the start of the year from H1 to H2. The specified period may be negative.

This instance is immutable and unaffected by this method call.

Parameters:

halves - the halves to subtract, positive or negative

Returns:

the resulting half, not null

length

public int length(boolean leapYear)

Gets the length of this half in days.

This takes a flag to determine whether to return the length for a leap year or not.

H1 has 181 in a standard year and 182 days in a leap year. H2 has 184 days.

Parameters:

leapYear - true if the length is required for a leap year

Returns:

the length of this month in days, 181, 182 or 184

firstMonth

public Month firstMonth()

Gets the first of the six months that this half refers to.

H1 will return January.
H2 will return July.

Returns:

the first month in the half, not null

query

public <R> R query(TemporalQuery<R> query)

Queries this half-of-year using the specified query.

This queries this half-of-year 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 passing this as the argument.

Specified by:

query in interface TemporalAccessor

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 half-of-year.

This returns a temporal object of the same observable type as the input with the half-of-year changed to be the same as this.

The adjustment is equivalent to using Temporal.with(TemporalField, long) passing TemporalFields.HALF_OF_YEAR as the field. If the specified temporal object does not use the ISO calendar system then a DateTimeException 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 = thisHalf.adjustInto(temporal);
   temporal = temporal.with(thisHalf);
 

For example, given a date in May, the following are output:

   dateInMay.with(H1);    // no change
   dateInMay.with(H2);    // six months later
 

This instance is immutable and unaffected by this method call.

Specified by:

adjustInto in interface TemporalAdjuster

Parameters:

temporal - the target object to be adjusted, not null

Returns:

the adjusted object, not null

Throws:

DateTimeException - if unable to make the adjustment

ArithmeticException - if numeric overflow occurs