ThreeTen-Extra 1.8.0 · org.threeten.extra.HourMinute

Modifier and Type	Field and Description
private final int	hour The hour-of-day.
private static final int	HOURS_PER_DAY Hours per day.
public static final HourMinute	MIDNIGHT The time of midnight at the start of the day, '00:00'.
private final int	minute The minute-of-hour.
private static final int	MINUTES_PER_DAY Minutes per day.
private static final int	MINUTES_PER_HOUR Minutes per hour.
private static final DateTimeFormatter	PARSER Parser.
private static final long	serialVersionUID Serialization version.

Access	Constructor and Description
private	HourMinute(int the hour to represent, validated from 0 to 23 hour, int the minute-of-hour to represent, validated from 0 to 59 minute) Constructor.

Method Summary

Modifier and Type	Method and Description
public Temporal	Returns: the adjusted object, not null adjustInto(Temporal the target object to be adjusted, not null temporal) Implements java.time.temporal.TemporalAdjuster.adjustInto. Adjusts the specified temporal object to have this hour-minute.
public LocalDateTime	Returns: the local date-time formed from this time and the specified date, not null atDate(LocalDate the date to combine with, not null date) Combines this time with a date to create a `LocalDateTime`.
public OffsetTime	Returns: the offset time formed from this time and the specified offset, not null atOffset(ZoneOffset the offset to combine with, not null offset) Combines this time with an offset to create an `OffsetTime`.
public int	Returns: the comparator value, negative if less, positive if greater compareTo(HourMinute the other hour-minute to compare to, not null other) Implements java.lang.Comparable.compareTo. Compares this hour-minute to another The comparison is based first on the value of the hour, then on the value of the minute.
public boolean	Returns: true if this is equal to the other hour-minute equals(Object the object to check, null returns false obj) Overrides java.lang.Object.equals. Checks if this hour-minute is equal to another hour-minute.
public String	Returns: the formatted hour-minute string, not null format(DateTimeFormatter the formatter to use, not null formatter) Formats this hour-minute using the specified formatter.
public static HourMinute	Returns: the hour-minute, not null from(TemporalAccessor the temporal object to convert, not null temporal) Obtains an instance of `HourMinute` from a temporal object.
public int	Returns: the value for the field get(TemporalField the field to get, not null field) Overrides default java.time.temporal.TemporalAccessor.get. Gets the value of the specified field from this hour-minute as an `int`.
private int	get0(TemporalField field)
public int	Returns: the hour, from 0 to 23 getHour() Gets the hour field, from 0 to 23.
public long	Returns: the value for the field getLong(TemporalField the field to get, not null field) Implements java.time.temporal.TemporalAccessor.getLong. Gets the value of the specified field from this hour-minute as a `long`.
public int	Returns: the minute-of-hour, from 0 to 59 getMinute() Gets the minute-of-hour field from 0 to 59.
public int	Returns: a suitable hash code hashCode() Overrides java.lang.Object.hashCode. A hash code for this hour-minute.
public boolean	Returns: true if this is after the specified hour-minute isAfter(HourMinute the other hour-minute to compare to, not null other) Is this hour-minute after the specified hour-minute.
public boolean	Returns: true if this point is before the specified hour-minute isBefore(HourMinute the other hour-minute to compare to, not null other) Is this hour-minute before the specified hour-minute.
public boolean	Returns: true if the field is supported on this hour-minute, false if not isSupported(TemporalField the field to check, null returns false field) Implements java.time.temporal.TemporalAccessor.isSupported. Checks if the specified field is supported.
public boolean	Returns: true if the unit can be added/subtracted, false if not isSupported(TemporalUnit the unit to check, null returns false unit) Implements java.time.temporal.Temporal.isSupported. Checks if the specified unit is supported.
public HourMinute	Returns: a `HourMinute` based on this hour-minute with the subtraction made, not null minus(TemporalAmount the amount to subtract, not null amountToSubtract) Overrides default java.time.temporal.Temporal.minus. Returns a copy of this hour-minute with the specified amount subtracted.
public HourMinute	Returns: a `HourMinute` based on this hour-minute with the specified amount subtracted, not null minus(long the amount of the unit to subtract from the result, may be negative amountToSubtract, TemporalUnit the unit of the amount to subtract, not null unit) Overrides default java.time.temporal.Temporal.minus. Returns a copy of this hour-minute with the specified amount subtracted.
public HourMinute	Returns: a `HourMinute` based on this hour-minute with the hours subtracted, not null minusHours(long the hours to subtract, may be negative hoursToSubtract) Returns a copy of this hour-minute with the specified period in hours subtracted.
public HourMinute	Returns: a `HourMinute` based on this hour-minute with the minutes subtracted, not null minusMinutes(long the minutes to subtract, may be negative minutesToSubtract) Returns a copy of this hour-minute with the specified period in minutes subtracted.
public static HourMinute	Returns: the current hour-minute using the system clock and default time-zone, not null now() Obtains the current hour-minute from the system clock in the default time-zone.
public static HourMinute	Returns: the current hour-minute using the system clock, not null now(ZoneId the zone ID to use, not null zone) Obtains the current hour-minute from the system clock in the specified time-zone.
public static HourMinute	Returns: the current hour-minute, not null now(Clock the clock to use, not null clock) Obtains the current hour-minute from the specified clock.
public static HourMinute	Returns: the hour-minute, not null of(int the hour to represent, from 0 to 23 hour, int the minute-of-hour to represent, from 0 to 59 minute) Obtains an instance of `HourMinute` from a hour and minute.
public static HourMinute	Returns: the parsed hour-minute, not null parse(CharSequence the text to parse such as "12:31", not null text) Obtains an instance of `HourMinute` from a text string such as `12:31`.
public static HourMinute	Returns: the parsed hour-minute, not null parse(CharSequence the text to parse, not null text, DateTimeFormatter the formatter to use, not null formatter) Obtains an instance of `HourMinute` from a text string using a specific formatter.
public HourMinute	Returns: a `HourMinute` based on this hour-minute with the addition made, not null plus(TemporalAmount the amount to add, not null amountToAdd) Overrides default java.time.temporal.Temporal.plus. Returns a copy of this hour-minute with the specified amount added.
public HourMinute	Returns: a `HourMinute` based on this hour-minute with the specified amount added, not null plus(long the amount of the unit to add to the result, may be negative amountToAdd, TemporalUnit the unit of the amount to add, not null unit) Implements java.time.temporal.Temporal.plus. Returns a copy of this hour-minute with the specified amount added.
public HourMinute	Returns: an `HourMinute` based on this time with the hours added, not null plusHours(long the hours to add, may be negative hoursToAdd) Returns a copy of this `HourMinute` with the specified number of hours added.
public HourMinute	Returns: an `HourMinute` based on this time with the minutes added, not null plusMinutes(long the minutes to add, may be negative minutesToAdd) Returns a copy of this `HourMinute` with the specified number of minutes added.
public < the type of the result R> R	Returns: the query result, null may be returned (defined by the query) query(TemporalQuery<R> the query to invoke, not null query) Overrides default java.time.temporal.TemporalAccessor.query. Queries this hour-minute using the specified query.
public ValueRange	Returns: the range of valid values for the field, not null range(TemporalField the field to query the range for, not null field) Overrides default java.time.temporal.TemporalAccessor.range. Gets the range of valid values for the specified field.
private Object	Returns: the valid object, not null readResolve() Validates the input.
public LocalTime	Returns: the equivalent local time, not null toLocalTime() Returns the equivalent `LocalTime`.
public String	Returns: a string representation of this hour-minute, not null toString() Overrides java.lang.Object.toString. Outputs this hour-minute as a `String`, such as `12:31`.
public long	Returns: the amount of time between this hour-minute and the end hour-minute until(Temporal the end date, exclusive, which is converted to a `HourMinute`, not null endExclusive, TemporalUnit the unit to measure the amount in, not null unit) Implements java.time.temporal.Temporal.until. Calculates the amount of time until another hour-minute in terms of the specified unit.
private HourMinute	Returns: the hour-minute, not null with(int the hour to represent, validated from 0 to 23 newYear, int the minute-of-hour to represent, validated from 0 to 59 newMinute) Returns a copy of this hour-minute with the new hour and minute, checking to see if a new object is in fact required.
public HourMinute	Returns: a `HourMinute` based on `this` with the adjustment made, not null with(TemporalAdjuster the adjuster to use, not null adjuster) Overrides default java.time.temporal.Temporal.with. Returns an adjusted copy of this hour-minute.
public HourMinute	Returns: a `HourMinute` based on `this` with the specified field set, not null with(TemporalField the field to set in the result, not null field, long the new value of the field in the result newValue) Implements java.time.temporal.Temporal.with. Returns a copy of this hour-minute with the specified field set to a new value.
public HourMinute	Returns: a `HourMinute` based on this hour-minute with the requested hour, not null withHour(int the hour to set in the returned hour-minute, from 0 to 23 hour) Returns a copy of this `HourMinute` with the hour altered.
public HourMinute	Returns: a `HourMinute` based on this hour-minute with the requested minute, not null withMinute(int the minute-of-hour to set in the returned hour-minute, from 0 to 59 minute) Returns a copy of this `HourMinute` with the minute-of-hour altered.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

hour	back to summary
private final int hour The hour-of-day.

HOURS_PER_DAY	back to summary
private static final int HOURS_PER_DAY Hours per day.

MIDNIGHT	back to summary
public static final HourMinute MIDNIGHT The time of midnight at the start of the day, '00:00'.

minute	back to summary
private final int minute The minute-of-hour.

MINUTES_PER_DAY	back to summary
private static final int MINUTES_PER_DAY Minutes per day.

MINUTES_PER_HOUR	back to summary
private static final int MINUTES_PER_HOUR Minutes per hour.

PARSER	back to summary
private static final DateTimeFormatter PARSER Parser.

serialVersionUID	back to summary
private static final long serialVersionUID Serialization version.

HourMinute	back to summary
private HourMinute(int hour, int minute) Constructor. Parameters hour:int the hour to represent, validated from 0 to 23 minute:int the minute-of-hour to represent, validated from 0 to 59

Method Detail

adjustInto back to summary

adjustInto	back to summary
public Temporal adjustInto(Temporal temporal) Implements java.time.temporal.TemporalAdjuster.adjustInto. Adjusts the specified temporal object to have this hour-minute. Note that if the target has a second or nanosecond field, that is not altered by this method. This returns a temporal object of the same observable type as the input with the hour and minute changed to be the same as this. The adjustment is equivalent to using `Temporal#with(TemporalField, long)` passing `ChronoField#MINUTE_OF_DAY` as the field. Note that this does not affect any second/nanosecond field in the target. 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 = thisHourMinute.adjustInto(temporal); temporal = temporal.with(thisHourMinute); This instance is immutable and unaffected by this method call. Parameters temporal:Temporal the target object to be adjusted, not null Returns:Temporal the adjusted object, not null Annotations @Override Exceptions DateTimeException: if unable to make the adjustment ArithmeticException: if numeric overflow occurs

public Temporal adjustInto(Temporal temporal)

Implements java.time.temporal.TemporalAdjuster.adjustInto.

Adjusts the specified temporal object to have this hour-minute. Note that if the target has a second or nanosecond field, that is not altered by this method.

This returns a temporal object of the same observable type as the input with the hour and minute changed to be the same as this.

The adjustment is equivalent to using Temporal#with(TemporalField, long) passing ChronoField#MINUTE_OF_DAY as the field. Note that this does not affect any second/nanosecond field in the target.

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 = thisHourMinute.adjustInto(temporal);
  temporal = temporal.with(thisHourMinute);

This instance is immutable and unaffected by this method call.

Parameters

temporal:Temporal: the target object to be adjusted, not null

Returns:Temporal

the adjusted object, not null

Annotations

@Override

Exceptions

DateTimeException:: if unable to make the adjustment
ArithmeticException:: if numeric overflow occurs

atDate back to summary

atDate	back to summary
public LocalDateTime atDate(LocalDate date) Combines this time with a date to create a `LocalDateTime`. This returns a `LocalDateTime` formed from this time at the specified date. All possible combinations of date and time are valid. Parameters date:LocalDate the date to combine with, not null Returns:LocalDateTime the local date-time formed from this time and the specified date, not null

public LocalDateTime atDate(LocalDate date)

Combines this time with a date to create a LocalDateTime.

This returns a LocalDateTime formed from this time at the specified date. All possible combinations of date and time are valid.

Parameters

date:LocalDate: the date to combine with, not null

Returns:LocalDateTime

the local date-time formed from this time and the specified date, not null

atOffset back to summary

atOffset	back to summary
public OffsetTime atOffset(ZoneOffset offset) Combines this time with an offset to create an `OffsetTime`. This returns an `OffsetTime` formed from this time at the specified offset. All possible combinations of time and offset are valid. Parameters offset:ZoneOffset the offset to combine with, not null Returns:OffsetTime the offset time formed from this time and the specified offset, not null

public OffsetTime atOffset(ZoneOffset offset)

Combines this time with an offset to create an OffsetTime.

This returns an OffsetTime formed from this time at the specified offset. All possible combinations of time and offset are valid.

Parameters

offset:ZoneOffset: the offset to combine with, not null

Returns:OffsetTime

the offset time formed from this time and the specified offset, not null

compareTo back to summary

compareTo	back to summary
public int compareTo(HourMinute other) Implements java.lang.Comparable.compareTo. Compares this hour-minute to another The comparison is based first on the value of the hour, then on the value of the minute. It is "consistent with equals", as defined by `Comparable`. Parameters other:HourMinute the other hour-minute to compare to, not null Returns:int the comparator value, negative if less, positive if greater Annotations @Override

public int compareTo(HourMinute other)

Implements java.lang.Comparable.compareTo.

Compares this hour-minute to another

The comparison is based first on the value of the hour, then on the value of the minute. It is "consistent with equals", as defined by Comparable.

Parameters

other:HourMinute: the other hour-minute to compare to, not null

Returns:int

the comparator value, negative if less, positive if greater

Annotations

@Override

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Checks if this hour-minute is equal to another hour-minute. The comparison is based on the time-line position of the hour-minute. Parameters obj:Object the object to check, null returns false Returns:boolean true if this is equal to the other hour-minute Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Checks if this hour-minute is equal to another hour-minute.

The comparison is based on the time-line position of the hour-minute.

Parameters

obj:Object: the object to check, null returns false

Returns:boolean

true if this is equal to the other hour-minute

Annotations

@Override

format	back to summary
public String format(DateTimeFormatter formatter) Formats this hour-minute using the specified formatter. This hour-minute will be passed to the formatter to produce a string. Parameters formatter:DateTimeFormatter the formatter to use, not null Returns:String the formatted hour-minute string, not null Exceptions DateTimeException: if an error occurs during printing

format

back to summary

public String format(DateTimeFormatter formatter)

Formats this hour-minute using the specified formatter.

This hour-minute will be passed to the formatter to produce a string.

Parameters

formatter:DateTimeFormatter: the formatter to use, not null

Returns:String

the formatted hour-minute string, not null

Exceptions

DateTimeException:: if an error occurs during printing

from back to summary

from	back to summary
public static HourMinute from(TemporalAccessor temporal) Obtains an instance of `HourMinute` from a temporal object. This obtains a hour-minute based on the specified temporal. A `TemporalAccessor` represents an arbitrary set of date and time information, which this factory converts to an instance of `HourMinute`. The conversion extracts the `HOUR_OF_DAY` and `MINUTE_OF_HOUR` fields. This method matches the signature of the functional interface `TemporalQuery` allowing it to be used in queries via method reference, `HourMinute::from`. Parameters temporal:TemporalAccessor the temporal object to convert, not null Returns:HourMinute the hour-minute, not null Exceptions DateTimeException: if unable to convert to a `HourMinute`

public static HourMinute from(TemporalAccessor temporal)

Obtains an instance of HourMinute from a temporal object.

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

The conversion extracts the HOUR_OF_DAY and MINUTE_OF_HOUR fields.

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

Parameters

temporal:TemporalAccessor: the temporal object to convert, not null

Returns:HourMinute

the hour-minute, not null

Exceptions

DateTimeException:: if unable to convert to a HourMinute

get back to summary

get	back to summary
public int get(TemporalField field) Overrides default java.time.temporal.TemporalAccessor.get. Gets the value of the specified field from this hour-minute as an `int`. This queries this hour-minute 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. The `supported fields` will return valid values based on this hour-minute,. 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. Parameters field:TemporalField the field to get, not null Returns:int the value for the field Annotations @Override Exceptions 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

public int get(TemporalField field)

Overrides default java.time.temporal.TemporalAccessor.get.

Gets the value of the specified field from this hour-minute as an int.

This queries this hour-minute 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. The supported fields will return valid values based on this hour-minute,. 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.

Parameters

field:TemporalField: the field to get, not null

Returns:int

the value for the field

Annotations

@Override

Exceptions

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

get0	back to summary
private int get0(TemporalField field)

getHour back to summary

getHour	back to summary
public int getHour() Gets the hour field, from 0 to 23. This method returns the hour as an `int` from 0 to 23. Returns:int the hour, from 0 to 23

public int getHour()

Gets the hour field, from 0 to 23.

This method returns the hour as an int from 0 to 23.

Returns:int: the hour, from 0 to 23

getLong back to summary

getLong	back to summary
public long getLong(TemporalField field) Implements java.time.temporal.TemporalAccessor.getLong. Gets the value of the specified field from this hour-minute as a `long`. This queries this hour-minute 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. The `supported fields` will return valid values based on this hour-minute. 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. Parameters field:TemporalField the field to get, not null Returns:long the value for the field Annotations @Override Exceptions DateTimeException: if a value for the field cannot be obtained UnsupportedTemporalTypeException: if the field is not supported ArithmeticException: if numeric overflow occurs

public long getLong(TemporalField field)

Implements java.time.temporal.TemporalAccessor.getLong.

Gets the value of the specified field from this hour-minute as a long.

This queries this hour-minute 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. The supported fields will return valid values based on this hour-minute. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

Parameters

field:TemporalField: the field to get, not null

Returns:long

the value for the field

Annotations

@Override

Exceptions

DateTimeException:: if a value for the field cannot be obtained
UnsupportedTemporalTypeException:: if the field is not supported
ArithmeticException:: if numeric overflow occurs

getMinute back to summary

getMinute	back to summary
public int getMinute() Gets the minute-of-hour field from 0 to 59. This method returns the minute as an `int` from 0 to 59. Returns:int the minute-of-hour, from 0 to 59

public int getMinute()

Gets the minute-of-hour field from 0 to 59.

This method returns the minute as an int from 0 to 59.

Returns:int: the minute-of-hour, from 0 to 59

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. A hash code for this hour-minute. Returns:int a suitable hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

A hash code for this hour-minute.

Returns:int

a suitable hash code

Annotations

@Override

isAfter	back to summary
public boolean isAfter(HourMinute other) Is this hour-minute after the specified hour-minute. Parameters other:HourMinute the other hour-minute to compare to, not null Returns:boolean true if this is after the specified hour-minute

isAfter

back to summary

public boolean isAfter(HourMinute other)

Is this hour-minute after the specified hour-minute.

Parameters

other:HourMinute: the other hour-minute to compare to, not null

Returns:boolean

true if this is after the specified hour-minute

isBefore	back to summary
public boolean isBefore(HourMinute other) Is this hour-minute before the specified hour-minute. Parameters other:HourMinute the other hour-minute to compare to, not null Returns:boolean true if this point is before the specified hour-minute

isBefore

back to summary

public boolean isBefore(HourMinute other)

Is this hour-minute before the specified hour-minute.

Parameters

other:HourMinute: the other hour-minute to compare to, not null

Returns:boolean

true if this point is before the specified hour-minute

isSupported back to summary

isSupported	back to summary
public boolean isSupported(TemporalField field) Implements java.time.temporal.TemporalAccessor.isSupported. Checks if the specified field is supported. This checks if this hour-minute can be queried for the specified field. If false, then calling the `range`, `get` and `with(TemporalField, long)` methods will throw an exception. If the field is a `ChronoField` then the query is implemented here. The supported fields are: `MINUTE_OF_HOUR` `MINUTE_OF_DAY` `HOUR_OF_AMPM` `CLOCK_HOUR_OF_AMPM` `HOUR_OF_DAY` `CLOCK_HOUR_OF_DAY` `AMPM_OF_DAY` All other `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. Parameters field:TemporalField the field to check, null returns false Returns:boolean true if the field is supported on this hour-minute, false if not Annotations @Override

public boolean isSupported(TemporalField field)

Implements java.time.temporal.TemporalAccessor.isSupported.

Checks if the specified field is supported.

This checks if this hour-minute can be queried for the specified field. If false, then calling the range, get and with(TemporalField, long) methods will throw an exception.

If the field is a ChronoField then the query is implemented here. The supported fields are:

MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR_OF_AMPM
CLOCK_HOUR_OF_AMPM
HOUR_OF_DAY
CLOCK_HOUR_OF_DAY
AMPM_OF_DAY

All other 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.

Parameters

field:TemporalField: the field to check, null returns false

Returns:boolean

true if the field is supported on this hour-minute, false if not

Annotations

@Override

isSupported back to summary

isSupported	back to summary
public boolean isSupported(TemporalUnit unit) Implements java.time.temporal.Temporal.isSupported. Checks if the specified unit is supported. This checks if the specified unit can be added to, or subtracted from, this hour-minute. If false, then calling the `plus(long, TemporalUnit)` and `minus` methods will throw an exception. If the unit is a `ChronoUnit` then the query is implemented here. The supported units are: `MINUTES` `HOURS` `HALF_DAYS` All other `ChronoUnit` instances will return false. If the unit is not a `ChronoUnit`, then the result of this method is obtained by invoking `TemporalUnit.isSupportedBy(Temporal)` passing `this` as the argument. Whether the unit is supported is determined by the unit. Parameters unit:TemporalUnit the unit to check, null returns false Returns:boolean true if the unit can be added/subtracted, false if not Annotations @Override

public boolean isSupported(TemporalUnit unit)

Implements java.time.temporal.Temporal.isSupported.

Checks if the specified unit is supported.

This checks if the specified unit can be added to, or subtracted from, this hour-minute. If false, then calling the plus(long, TemporalUnit) and minus methods will throw an exception.

If the unit is a ChronoUnit then the query is implemented here. The supported units are:

MINUTES
HOURS
HALF_DAYS

All other ChronoUnit instances will return false.

If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument. Whether the unit is supported is determined by the unit.

Parameters

unit:TemporalUnit: the unit to check, null returns false

Returns:boolean

true if the unit can be added/subtracted, false if not

Annotations

@Override

minus back to summary

minus	back to summary
public HourMinute minus(TemporalAmount amountToSubtract) Overrides default java.time.temporal.Temporal.minus. Returns a copy of this hour-minute with the specified amount subtracted. This returns a `HourMinute` based on this one, with the specified amount subtracted. The amount is typically `Period` but may be any other type implementing the `TemporalAmount` 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 to `minus(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. Parameters amountToSubtract:TemporalAmount the amount to subtract, not null Returns:HourMinute a `HourMinute` based on this hour-minute with the subtraction made, not null Annotations @Override Exceptions DateTimeException: if the subtraction cannot be made ArithmeticException: if numeric overflow occurs

public HourMinute minus(TemporalAmount amountToSubtract)

Overrides default java.time.temporal.Temporal.minus.

Returns a copy of this hour-minute with the specified amount subtracted.

This returns a HourMinute based on this one, with the specified amount subtracted. The amount is typically Period but may be any other type implementing the TemporalAmount 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 to minus(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.

Parameters

amountToSubtract:TemporalAmount: the amount to subtract, not null

Returns:HourMinute

a HourMinute based on this hour-minute with the subtraction made, not null

Annotations

@Override

Exceptions

DateTimeException:: if the subtraction cannot be made
ArithmeticException:: if numeric overflow occurs

minus back to summary

minus	back to summary
public HourMinute minus(long amountToSubtract, TemporalUnit unit) Overrides default java.time.temporal.Temporal.minus. Returns a copy of this hour-minute with the specified amount subtracted. This returns a `HourMinute` 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. Parameters amountToSubtract:long the amount of the unit to subtract from the result, may be negative unit:TemporalUnit the unit of the amount to subtract, not null Returns:HourMinute a `HourMinute` based on this hour-minute with the specified amount subtracted, not null Annotations @Override Exceptions DateTimeException: if the subtraction cannot be made UnsupportedTemporalTypeException: if the unit is not supported ArithmeticException: if numeric overflow occurs

public HourMinute minus(long amountToSubtract, TemporalUnit unit)

Overrides default java.time.temporal.Temporal.minus.

Returns a copy of this hour-minute with the specified amount subtracted.

This returns a HourMinute 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.

Parameters

amountToSubtract:long: the amount of the unit to subtract from the result, may be negative
unit:TemporalUnit: the unit of the amount to subtract, not null

Returns:HourMinute

a HourMinute based on this hour-minute with the specified amount subtracted, not null

Annotations

@Override

Exceptions

DateTimeException:: if the subtraction cannot be made
UnsupportedTemporalTypeException:: if the unit is not supported
ArithmeticException:: if numeric overflow occurs

minusHours back to summary

minusHours	back to summary
public HourMinute minusHours(long hoursToSubtract) Returns a copy of this hour-minute with the specified period in hours subtracted. This instance is immutable and unaffected by this method call. Parameters hoursToSubtract:long the hours to subtract, may be negative Returns:HourMinute a `HourMinute` based on this hour-minute with the hours subtracted, not null Exceptions DateTimeException: if the result exceeds the supported range

public HourMinute minusHours(long hoursToSubtract)

Returns a copy of this hour-minute with the specified period in hours subtracted.

This instance is immutable and unaffected by this method call.

Parameters

hoursToSubtract:long: the hours to subtract, may be negative

Returns:HourMinute

a HourMinute based on this hour-minute with the hours subtracted, not null

Exceptions

DateTimeException:: if the result exceeds the supported range

minusMinutes back to summary

minusMinutes	back to summary
public HourMinute minusMinutes(long minutesToSubtract) Returns a copy of this hour-minute with the specified period in minutes subtracted. This instance is immutable and unaffected by this method call. Parameters minutesToSubtract:long the minutes to subtract, may be negative Returns:HourMinute a `HourMinute` based on this hour-minute with the minutes subtracted, not null Exceptions DateTimeException: if the result exceeds the supported range

public HourMinute minusMinutes(long minutesToSubtract)

Returns a copy of this hour-minute with the specified period in minutes subtracted.

This instance is immutable and unaffected by this method call.

Parameters

minutesToSubtract:long: the minutes to subtract, may be negative

Returns:HourMinute

a HourMinute based on this hour-minute with the minutes subtracted, not null

Exceptions

DateTimeException:: if the result exceeds the supported range

now back to summary

now	back to summary
public static HourMinute now() Obtains the current hour-minute from the system clock in the default time-zone. This will query the `system clock` in the default time-zone to obtain the current hour-minute. 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:HourMinute the current hour-minute using the system clock and default time-zone, not null

public static HourMinute now()

Obtains the current hour-minute from the system clock in the default time-zone.

This will query the system clock in the default time-zone to obtain the current hour-minute. 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:HourMinute: the current hour-minute using the system clock and default time-zone, not null

now back to summary

now	back to summary
public static HourMinute now(ZoneId zone) Obtains the current hour-minute from the system clock in the specified time-zone. This will query the `system clock` to obtain the current hour-minute. 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:ZoneId the zone ID to use, not null Returns:HourMinute the current hour-minute using the system clock, not null

public static HourMinute now(ZoneId zone)

Obtains the current hour-minute from the system clock in the specified time-zone.

This will query the system clock to obtain the current hour-minute. 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:ZoneId: the zone ID to use, not null

Returns:HourMinute

the current hour-minute using the system clock, not null

now back to summary

now	back to summary
public static HourMinute now(Clock clock) Obtains the current hour-minute from the specified clock. This will query the specified clock to obtain the current hour-minute. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using `dependency injection`. Parameters clock:Clock the clock to use, not null Returns:HourMinute the current hour-minute, not null

public static HourMinute now(Clock clock)

Obtains the current hour-minute from the specified clock.

This will query the specified clock to obtain the current hour-minute. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

Parameters

clock:Clock: the clock to use, not null

Returns:HourMinute

the current hour-minute, not null

of back to summary

of	back to summary
public static HourMinute of(int hour, int minute) Obtains an instance of `HourMinute` from a hour and minute. Parameters hour:int the hour to represent, from 0 to 23 minute:int the minute-of-hour to represent, from 0 to 59 Returns:HourMinute the hour-minute, not null Exceptions DateTimeException: if either field value is invalid

public static HourMinute of(int hour, int minute)

Obtains an instance of HourMinute from a hour and minute.

Parameters

hour:int: the hour to represent, from 0 to 23
minute:int: the minute-of-hour to represent, from 0 to 59

Returns:HourMinute

the hour-minute, not null

Exceptions

DateTimeException:: if either field value is invalid

parse back to summary

parse	back to summary
public static HourMinute parse(CharSequence text) Obtains an instance of `HourMinute` from a text string such as `12:31`. The string must represent a valid hour-minute. The format must be `HH:mm`. Parameters text:CharSequence the text to parse such as "12:31", not null Returns:HourMinute the parsed hour-minute, not null Annotations @FromString Exceptions DateTimeParseException: if the text cannot be parsed

public static HourMinute parse(CharSequence text)

Obtains an instance of HourMinute from a text string such as 12:31.

The string must represent a valid hour-minute. The format must be HH:mm.

Parameters

text:CharSequence: the text to parse such as "12:31", not null

Returns:HourMinute

the parsed hour-minute, not null

Annotations

@FromString

Exceptions

DateTimeParseException:: if the text cannot be parsed

parse back to summary

parse	back to summary
public static HourMinute parse(CharSequence text, DateTimeFormatter formatter) Obtains an instance of `HourMinute` from a text string using a specific formatter. The text is parsed using the formatter, returning a hour-minute. Parameters text:CharSequence the text to parse, not null formatter:DateTimeFormatter the formatter to use, not null Returns:HourMinute the parsed hour-minute, not null Exceptions DateTimeParseException: if the text cannot be parsed

public static HourMinute parse(CharSequence text, DateTimeFormatter formatter)

Obtains an instance of HourMinute from a text string using a specific formatter.

The text is parsed using the formatter, returning a hour-minute.

Parameters

text:CharSequence: the text to parse, not null
formatter:DateTimeFormatter: the formatter to use, not null

Returns:HourMinute

the parsed hour-minute, not null

Exceptions

DateTimeParseException:: if the text cannot be parsed

plus back to summary

plus	back to summary
public HourMinute plus(TemporalAmount amountToAdd) Overrides default java.time.temporal.Temporal.plus. Returns a copy of this hour-minute with the specified amount added. This returns a `HourMinute` based on this one, with the specified amount added. The amount is typically `Period` but may be any other type implementing the `TemporalAmount` 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 to `plus(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. Parameters amountToAdd:TemporalAmount the amount to add, not null Returns:HourMinute a `HourMinute` based on this hour-minute with the addition made, not null Annotations @Override Exceptions DateTimeException: if the addition cannot be made ArithmeticException: if numeric overflow occurs

public HourMinute plus(TemporalAmount amountToAdd)

Overrides default java.time.temporal.Temporal.plus.

Returns a copy of this hour-minute with the specified amount added.

This returns a HourMinute based on this one, with the specified amount added. The amount is typically Period but may be any other type implementing the TemporalAmount 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 to plus(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.

Parameters

amountToAdd:TemporalAmount: the amount to add, not null

Returns:HourMinute

a HourMinute based on this hour-minute with the addition made, not null

Annotations

@Override

Exceptions

DateTimeException:: if the addition cannot be made
ArithmeticException:: if numeric overflow occurs

plus back to summary

plus	back to summary
public HourMinute plus(long amountToAdd, TemporalUnit unit) Implements java.time.temporal.Temporal.plus. Returns a copy of this hour-minute with the specified amount added. This returns a `HourMinute` 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: `MINUTES` - Returns a `LocalTime` with the specified number of minutes added. This is equivalent to `plusMinutes(long)`. `HOURS` - Returns a `LocalTime` with the specified number of hours added. This is equivalent to `plusHours(long)`. `HALF_DAYS` - Returns a `LocalTime` with the specified number of half-days added. This is equivalent to `plusHours(long)` with the amount multiplied by 12. All other `ChronoUnit` instances will throw an `UnsupportedTemporalTypeException`. If the field is not a `ChronoUnit`, then the result of this method is obtained by invoking `TemporalUnit.addTo(Temporal, long)` passing `this` 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. Parameters amountToAdd:long the amount of the unit to add to the result, may be negative unit:TemporalUnit the unit of the amount to add, not null Returns:HourMinute a `HourMinute` based on this hour-minute with the specified amount added, not null Annotations @Override Exceptions DateTimeException: if the addition cannot be made UnsupportedTemporalTypeException: if the unit is not supported ArithmeticException: if numeric overflow occurs

public HourMinute plus(long amountToAdd, TemporalUnit unit)

Implements java.time.temporal.Temporal.plus.

Returns a copy of this hour-minute with the specified amount added.

This returns a HourMinute 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:

MINUTES - Returns a LocalTime with the specified number of minutes added. This is equivalent to plusMinutes(long).
HOURS - Returns a LocalTime with the specified number of hours added. This is equivalent to plusHours(long).
HALF_DAYS - Returns a LocalTime with the specified number of half-days added. This is equivalent to plusHours(long) with the amount multiplied by 12.

All other ChronoUnit instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long) passing this 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.

Parameters

amountToAdd:long: the amount of the unit to add to the result, may be negative
unit:TemporalUnit: the unit of the amount to add, not null

Returns:HourMinute

a HourMinute based on this hour-minute with the specified amount added, not null

Annotations

@Override

Exceptions

DateTimeException:: if the addition cannot be made
UnsupportedTemporalTypeException:: if the unit is not supported
ArithmeticException:: if numeric overflow occurs

plusHours back to summary

plusHours	back to summary
public HourMinute plusHours(long hoursToAdd) Returns a copy of this `HourMinute` with the specified number of hours added. This adds the specified number of hours to this time, returning a new time. The calculation wraps around midnight. This instance is immutable and unaffected by this method call. Parameters hoursToAdd:long the hours to add, may be negative Returns:HourMinute an `HourMinute` based on this time with the hours added, not null

public HourMinute plusHours(long hoursToAdd)

Returns a copy of this HourMinute with the specified number of hours added.

This adds the specified number of hours to this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Parameters

hoursToAdd:long: the hours to add, may be negative

Returns:HourMinute

an HourMinute based on this time with the hours added, not null

plusMinutes back to summary

plusMinutes	back to summary
public HourMinute plusMinutes(long minutesToAdd) Returns a copy of this `HourMinute` with the specified number of minutes added. This adds the specified number of minutes to this time, returning a new time. The calculation wraps around midnight. This instance is immutable and unaffected by this method call. Parameters minutesToAdd:long the minutes to add, may be negative Returns:HourMinute an `HourMinute` based on this time with the minutes added, not null

public HourMinute plusMinutes(long minutesToAdd)

Returns a copy of this HourMinute with the specified number of minutes added.

This adds the specified number of minutes to this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Parameters

minutesToAdd:long: the minutes to add, may be negative

Returns:HourMinute

an HourMinute based on this time with the minutes added, not null

query back to summary

query	back to summary
public <R> R query(TemporalQuery<R> query) Overrides default java.time.temporal.TemporalAccessor.query. Queries this hour-minute using the specified query. This queries this hour-minute 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. Parameters <R> the type of the result query:TemporalQuery<R> the query to invoke, not null Returns:R the query result, null may be returned (defined by the query) Annotations @SuppressWarnings:unchecked @Override Exceptions DateTimeException: if unable to query (defined by the query) ArithmeticException: if numeric overflow occurs (defined by the query)

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

Overrides default java.time.temporal.TemporalAccessor.query.

Queries this hour-minute using the specified query.

This queries this hour-minute 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.

Parameters

<R>: the type of the result
query:TemporalQuery<R>: the query to invoke, not null

Returns:R

the query result, null may be returned (defined by the query)

Annotations

@SuppressWarnings:unchecked
@Override

Exceptions

DateTimeException:: if unable to query (defined by the query)
ArithmeticException:: if numeric overflow occurs (defined by the query)

range back to summary

range	back to summary
public ValueRange range(TemporalField field) Overrides default java.time.temporal.TemporalAccessor.range. Gets the range of valid values for the specified field. The range object expresses the minimum and maximum valid values for a field. 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. The `supported fields` will return appropriate range instances. 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.rangeRefinedBy(TemporalAccessor)` passing `this` as the argument. Whether the range can be obtained is determined by the field. Parameters field:TemporalField the field to query the range for, not null Returns:ValueRange the range of valid values for the field, not null Annotations @Override Exceptions DateTimeException: if the range for the field cannot be obtained UnsupportedTemporalTypeException: if the field is not supported

public ValueRange range(TemporalField field)

Overrides default java.time.temporal.TemporalAccessor.range.

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. 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. The supported fields will return appropriate range instances. 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.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

Parameters

field:TemporalField: the field to query the range for, not null

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

Exceptions

DateTimeException:: if the range for the field cannot be obtained
UnsupportedTemporalTypeException:: if the field is not supported

readResolve	back to summary
private Object readResolve() Validates the input. Returns:Object the valid object, not null

readResolve

back to summary

private Object readResolve()

Validates the input.

Returns:Object: the valid object, not null

toLocalTime back to summary

toLocalTime	back to summary
public LocalTime toLocalTime() Returns the equivalent `LocalTime`. This returns a `LocalTime` formed from this hour and minute. Returns:LocalTime the equivalent local time, not null

public LocalTime toLocalTime()

Returns the equivalent LocalTime.

This returns a LocalTime formed from this hour and minute.

Returns:LocalTime: the equivalent local time, not null

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Outputs this hour-minute as a `String`, such as `12:31`. Returns:String a string representation of this hour-minute, not null Annotations @Override @ToString

public String toString()

Overrides java.lang.Object.toString.

Outputs this hour-minute as a String, such as 12:31.

Returns:String

a string representation of this hour-minute, not null

Annotations

@Override
@ToString

until back to summary

until	back to summary
public long until(Temporal endExclusive, TemporalUnit unit) Implements java.time.temporal.Temporal.until. Calculates the amount of time until another hour-minute in terms of the specified unit. This calculates the amount of time between two `HourMinute` objects in terms of a single `TemporalUnit`. The start and end points are `this` and the specified hour-minute. The result will be negative if the end is before the start. The `Temporal` passed to this method is converted to a `HourMinute` using `from(TemporalAccessor)`. For example, the period in hours between two hour-minutes can be calculated using `startHourMinute.until(endHourMinute, YEARS)`. The calculation is implemented in this method for `ChronoUnit`. The units `MINUTES`, `HOURS` and `HALF_DAYS` are supported. Other `ChronoUnit` values will throw an exception. If the unit is not a `ChronoUnit`, then the result of this method is obtained by invoking `TemporalUnit.between(Temporal, Temporal)` passing `this` as the first argument and the converted input temporal as the second argument. This instance is immutable and unaffected by this method call. Parameters endExclusive:Temporal the end date, exclusive, which is converted to a `HourMinute`, not null unit:TemporalUnit the unit to measure the amount in, not null Returns:long the amount of time between this hour-minute and the end hour-minute Annotations @Override Exceptions DateTimeException: if the amount cannot be calculated, or the end temporal cannot be converted to a `HourMinute` UnsupportedTemporalTypeException: if the unit is not supported ArithmeticException: if numeric overflow occurs

public long until(Temporal endExclusive, TemporalUnit unit)

Implements java.time.temporal.Temporal.until.

Calculates the amount of time until another hour-minute in terms of the specified unit.

This calculates the amount of time between two HourMinute objects in terms of a single TemporalUnit. The start and end points are this and the specified hour-minute. The result will be negative if the end is before the start. The Temporal passed to this method is converted to a HourMinute using from(TemporalAccessor). For example, the period in hours between two hour-minutes can be calculated using startHourMinute.until(endHourMinute, YEARS).

The calculation is implemented in this method for ChronoUnit. The units MINUTES, HOURS and HALF_DAYS are supported. Other ChronoUnit values will throw an exception.

If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the converted input temporal as the second argument.

This instance is immutable and unaffected by this method call.

Parameters

endExclusive:Temporal: the end date, exclusive, which is converted to a HourMinute, not null
unit:TemporalUnit: the unit to measure the amount in, not null

Returns:long

the amount of time between this hour-minute and the end hour-minute

Annotations

@Override

Exceptions

DateTimeException:: if the amount cannot be calculated, or the end temporal cannot be converted to a HourMinute
UnsupportedTemporalTypeException:: if the unit is not supported
ArithmeticException:: if numeric overflow occurs

with	back to summary
private HourMinute with(int newYear, int newMinute) Returns a copy of this hour-minute with the new hour and minute, checking to see if a new object is in fact required. Parameters newYear:int the hour to represent, validated from 0 to 23 newMinute:int the minute-of-hour to represent, validated from 0 to 59 Returns:HourMinute the hour-minute, not null

with

back to summary

private HourMinute with(int newYear, int newMinute)

Returns a copy of this hour-minute with the new hour and minute, checking to see if a new object is in fact required.

Parameters

newYear:int: the hour to represent, validated from 0 to 23
newMinute:int: the minute-of-hour to represent, validated from 0 to 59

Returns:HourMinute

the hour-minute, not null

with back to summary

public HourMinute with(TemporalAdjuster adjuster)

Overrides default java.time.temporal.Temporal.with.

Returns an adjusted copy of this hour-minute.

This returns a HourMinute based on this one, with the hour-minute 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 passing this as the argument.

This instance is immutable and unaffected by this method call.

Parameters

adjuster:TemporalAdjuster: the adjuster to use, not null

Returns:HourMinute

a HourMinute based on this with the adjustment made, not null

Annotations

@Override

Exceptions

DateTimeException:: if the adjustment cannot be made
ArithmeticException:: if numeric overflow occurs

with back to summary

public HourMinute with(TemporalField field, long newValue)

Implements java.time.temporal.Temporal.with.

Returns a copy of this hour-minute with the specified field set to a new value.

This returns a HourMinute based on this one, with the value for the specified field changed. This can be used to change any supported field, such as the hour or minute. 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:

MINUTE_OF_HOUR - Returns a HourMinute with the specified minute-of-hour. The hour will be unchanged.
MINUTE_OF_DAY - Returns a HourMinute with the specified minute-of-day.
HOUR_OF_AMPM - Returns a HourMinute with the specified hour-of-am-pm. The AM/PM and minute-of-hour will be unchanged.
CLOCK_HOUR_OF_AMPM - Returns a HourMinute with the specified clock-hour-of-am-pm. The AM/PM and minute-of-hour will be unchanged.
HOUR_OF_DAY - Returns a HourMinute with the specified hour-of-day. The minute-of-hour will be unchanged.
CLOCK_HOUR_OF_DAY - Returns a HourMinute with the specified clock-hour-of-day. The minute-of-hour will be unchanged.
AMPM_OF_DAY - Returns a HourMinute with the specified AM/PM. The hour-of-am-pm and minute-of-hour 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 an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.adjustInto(Temporal, long) passing this 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.

Parameters

field:TemporalField: the field to set in the result, not null
newValue:long: the new value of the field in the result

Returns:HourMinute

a HourMinute based on this with the specified field set, not null

Annotations

@Override

Exceptions

DateTimeException:: if the field cannot be set
UnsupportedTemporalTypeException:: if the field is not supported
ArithmeticException:: if numeric overflow occurs

withHour back to summary

public HourMinute withHour(int hour)

Returns a copy of this HourMinute with the hour altered.

This instance is immutable and unaffected by this method call.

Parameters

hour:int: the hour to set in the returned hour-minute, from 0 to 23

Returns:HourMinute

a HourMinute based on this hour-minute with the requested hour, not null

Exceptions

DateTimeException:: if the hour value is invalid

withMinute back to summary

public HourMinute withMinute(int minute)

Returns a copy of this HourMinute with the minute-of-hour altered.

This instance is immutable and unaffected by this method call.

Parameters

minute:int: the minute-of-hour to set in the returned hour-minute, from 0 to 59

Returns:HourMinute

a HourMinute based on this hour-minute with the requested minute, not null

Exceptions

DateTimeException:: if the minute-of-hour value is invalid

public final Class HourMinute

Implementation Requirements:

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail