- java.lang.Object
-
- org.threeten.extra.HourMinute
-
- All Implemented Interfaces:
Serializable
,Comparable<HourMinute>
,Temporal
,TemporalAccessor
,TemporalAdjuster
public final class HourMinute extends Object implements Temporal, TemporalAdjuster, Comparable<HourMinute>, Serializable
An hour-minute, such as12:31
.This class is similar to
LocalTime
but has a precision of minutes. Seconds and nanoseconds cannot be represented by this class.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
-
-
Field Summary
Fields Modifier and Type Field Description static HourMinute
MIDNIGHT
The time of midnight at the start of the day, '00:00'.
-
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 hour-minute.LocalDateTime
atDate(LocalDate date)
Combines this time with a date to create aLocalDateTime
.OffsetTime
atOffset(ZoneOffset offset)
Combines this time with an offset to create anOffsetTime
.int
compareTo(HourMinute other)
Compares this hour-minute to anotherboolean
equals(Object obj)
Checks if this hour-minute is equal to another hour-minute.String
format(DateTimeFormatter formatter)
Formats this hour-minute using the specified formatter.static HourMinute
from(TemporalAccessor temporal)
Obtains an instance ofHourMinute
from a temporal object.int
get(TemporalField field)
Gets the value of the specified field from this hour-minute as anint
.int
getHour()
Gets the hour field, from 0 to 23.long
getLong(TemporalField field)
Gets the value of the specified field from this hour-minute as along
.int
getMinute()
Gets the minute-of-hour field from 0 to 59.int
hashCode()
A hash code for this hour-minute.boolean
isAfter(HourMinute other)
Is this hour-minute after the specified hour-minute.boolean
isBefore(HourMinute other)
Is this hour-minute before the specified hour-minute.boolean
isSupported(TemporalField field)
Checks if the specified field is supported.boolean
isSupported(TemporalUnit unit)
Checks if the specified unit is supported.HourMinute
minus(long amountToSubtract, TemporalUnit unit)
Returns a copy of this hour-minute with the specified amount subtracted.HourMinute
minus(TemporalAmount amountToSubtract)
Returns a copy of this hour-minute with the specified amount subtracted.HourMinute
minusHours(long hoursToSubtract)
Returns a copy of this hour-minute with the specified period in hours subtracted.HourMinute
minusMinutes(long minutesToSubtract)
Returns a copy of this hour-minute with the specified period in minutes subtracted.static HourMinute
now()
Obtains the current hour-minute from the system clock in the default time-zone.static HourMinute
now(Clock clock)
Obtains the current hour-minute from the specified clock.static HourMinute
now(ZoneId zone)
Obtains the current hour-minute from the system clock in the specified time-zone.static HourMinute
of(int hour, int minute)
Obtains an instance ofHourMinute
from a hour and minute.static HourMinute
parse(CharSequence text)
Obtains an instance ofHourMinute
from a text string such as12:31
.static HourMinute
parse(CharSequence text, DateTimeFormatter formatter)
Obtains an instance ofHourMinute
from a text string using a specific formatter.HourMinute
plus(long amountToAdd, TemporalUnit unit)
Returns a copy of this hour-minute with the specified amount added.HourMinute
plus(TemporalAmount amountToAdd)
Returns a copy of this hour-minute with the specified amount added.HourMinute
plusHours(long hoursToAdd)
Returns a copy of thisHourMinute
with the specified number of hours added.HourMinute
plusMinutes(long minutesToAdd)
Returns a copy of thisHourMinute
with the specified number of minutes added.<R> R
query(TemporalQuery<R> query)
Queries this hour-minute using the specified query.ValueRange
range(TemporalField field)
Gets the range of valid values for the specified field.LocalTime
toLocalTime()
Returns the equivalentLocalTime
.String
toString()
Outputs this hour-minute as aString
, such as12:31
.long
until(Temporal endExclusive, TemporalUnit unit)
Calculates the amount of time until another hour-minute in terms of the specified unit.HourMinute
with(TemporalAdjuster adjuster)
Returns an adjusted copy of this hour-minute.HourMinute
with(TemporalField field, long newValue)
Returns a copy of this hour-minute with the specified field set to a new value.HourMinute
withHour(int hour)
Returns a copy of thisHourMinute
with the hour altered.HourMinute
withMinute(int minute)
Returns a copy of thisHourMinute
with the minute-of-hour altered.
-
-
-
Field Detail
-
MIDNIGHT
public static final HourMinute MIDNIGHT
The time of midnight at the start of the day, '00:00'.
-
-
Method Detail
-
now
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:
- the current hour-minute using the system clock and default time-zone, not null
-
now
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
- the zone ID to use, not null- Returns:
- the current hour-minute using the system clock, not null
-
now
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
- the clock to use, not null- Returns:
- the current hour-minute, not null
-
of
public static HourMinute of(int hour, int minute)
Obtains an instance ofHourMinute
from a hour and minute.- Parameters:
hour
- the hour to represent, from 0 to 23minute
- the minute-of-hour to represent, from 0 to 59- Returns:
- the hour-minute, not null
- Throws:
DateTimeException
- if either field value is invalid
-
from
public static HourMinute from(TemporalAccessor temporal)
Obtains an instance ofHourMinute
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 ofHourMinute
.The conversion extracts the
HOUR_OF_DAY
andMINUTE_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
- the temporal object to convert, not null- Returns:
- the hour-minute, not null
- Throws:
DateTimeException
- if unable to convert to aHourMinute
-
parse
public static HourMinute parse(CharSequence text)
Obtains an instance ofHourMinute
from a text string such as12:31
.The string must represent a valid hour-minute. The format must be
HH:mm
.- Parameters:
text
- the text to parse such as "12:31", not null- Returns:
- the parsed hour-minute, not null
- Throws:
DateTimeParseException
- if the text cannot be parsed
-
parse
public static HourMinute parse(CharSequence text, DateTimeFormatter formatter)
Obtains an instance ofHourMinute
from a text string using a specific formatter.The text is parsed using the formatter, returning a hour-minute.
- Parameters:
text
- the text to parse, not nullformatter
- the formatter to use, not null- Returns:
- the parsed hour-minute, 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 hour-minute 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:MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR_OF_AMPM
CLOCK_HOUR_OF_AMPM
HOUR_OF_DAY
CLOCK_HOUR_OF_DAY
AMPM_OF_DAY
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 hour-minute, 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 hour-minute. 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:MINUTES
HOURS
HALF_DAYS
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. 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 hour-minute as anint
.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. Thesupported fields
will return valid values based on this hour-minute,. 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 hour-minute as along
.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. Thesupported fields
will return valid values based on this hour-minute. 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
-
getHour
public int getHour()
Gets the hour field, from 0 to 23.This method returns the hour as an
int
from 0 to 23.- Returns:
- the hour, from 0 to 23
-
getMinute
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:
- the minute-of-hour, from 0 to 59
-
with
public HourMinute with(TemporalAdjuster adjuster)
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 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
HourMinute
based onthis
with the adjustment made, not null - Throws:
DateTimeException
- if the adjustment cannot be madeArithmeticException
- if numeric overflow occurs
-
with
public HourMinute with(TemporalField field, long newValue)
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 aHourMinute
with the specified minute-of-hour. The hour will be unchanged.MINUTE_OF_DAY
- Returns aHourMinute
with the specified minute-of-day.HOUR_OF_AMPM
- Returns aHourMinute
with the specified hour-of-am-pm. The AM/PM and minute-of-hour will be unchanged.CLOCK_HOUR_OF_AMPM
- Returns aHourMinute
with the specified clock-hour-of-am-pm. The AM/PM and minute-of-hour will be unchanged.HOUR_OF_DAY
- Returns aHourMinute
with the specified hour-of-day. The minute-of-hour will be unchanged.CLOCK_HOUR_OF_DAY
- Returns aHourMinute
with the specified clock-hour-of-day. The minute-of-hour will be unchanged.AMPM_OF_DAY
- Returns aHourMinute
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 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
HourMinute
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
-
withHour
public HourMinute withHour(int hour)
Returns a copy of thisHourMinute
with the hour altered.This instance is immutable and unaffected by this method call.
- Parameters:
hour
- the hour to set in the returned hour-minute, from 0 to 23- Returns:
- a
HourMinute
based on this hour-minute with the requested hour, not null - Throws:
DateTimeException
- if the hour value is invalid
-
withMinute
public HourMinute withMinute(int minute)
Returns a copy of thisHourMinute
with the minute-of-hour altered.This instance is immutable and unaffected by this method call.
- Parameters:
minute
- the minute-of-hour to set in the returned hour-minute, from 0 to 59- Returns:
- a
HourMinute
based on this hour-minute with the requested minute, not null - Throws:
DateTimeException
- if the minute-of-hour value is invalid
-
plus
public HourMinute plus(TemporalAmount amountToAdd)
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 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
HourMinute
based on this hour-minute with the addition made, not null - Throws:
DateTimeException
- if the addition cannot be madeArithmeticException
- if numeric overflow occurs
-
plus
public HourMinute plus(long amountToAdd, TemporalUnit unit)
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 aLocalTime
with the specified number of minutes added. This is equivalent toplusMinutes(long)
.HOURS
- Returns aLocalTime
with the specified number of hours added. This is equivalent toplusHours(long)
.HALF_DAYS
- Returns aLocalTime
with the specified number of half-days added. This is equivalent toplusHours(long)
with the amount multiplied by 12.
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
HourMinute
based on this hour-minute 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
-
plusHours
public HourMinute plusHours(long hoursToAdd)
Returns a copy of thisHourMinute
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
- the hours to add, may be negative- Returns:
- an
HourMinute
based on this time with the hours added, not null
-
plusMinutes
public HourMinute plusMinutes(long minutesToAdd)
Returns a copy of thisHourMinute
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
- the minutes to add, may be negative- Returns:
- an
HourMinute
based on this time with the minutes added, not null
-
minus
public HourMinute minus(TemporalAmount amountToSubtract)
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 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
HourMinute
based on this hour-minute with the subtraction made, not null - Throws:
DateTimeException
- if the subtraction cannot be madeArithmeticException
- if numeric overflow occurs
-
minus
public HourMinute minus(long amountToSubtract, TemporalUnit unit)
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.
- 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
HourMinute
based on this hour-minute 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
-
minusHours
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
- the hours to subtract, may be negative- Returns:
- a
HourMinute
based on this hour-minute with the hours subtracted, not null - Throws:
DateTimeException
- if the result exceeds the supported range
-
minusMinutes
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
- the minutes to subtract, may be negative- Returns:
- a
HourMinute
based on this hour-minute with the minutes subtracted, not null - Throws:
DateTimeException
- if the result exceeds the supported range
-
query
public <R> R query(TemporalQuery<R> 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 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 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)
passingChronoField.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.
- 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 hour-minute in terms of the specified unit.This calculates the amount of time between two
HourMinute
objects in terms of a singleTemporalUnit
. The start and end points arethis
and the specified hour-minute. The result will be negative if the end is before the start. TheTemporal
passed to this method is converted to aHourMinute
usingfrom(TemporalAccessor)
. For example, the period in hours between two hour-minutes can be calculated usingstartHourMinute.until(endHourMinute, YEARS)
.The calculation is implemented in this method for
ChronoUnit
. The unitsMINUTES
,HOURS
andHALF_DAYS
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 aHourMinute
, not nullunit
- the unit to measure the amount in, not null- Returns:
- the amount of time between this hour-minute and the end hour-minute
- Throws:
DateTimeException
- if the amount cannot be calculated, or the end temporal cannot be converted to aHourMinute
UnsupportedTemporalTypeException
- if the unit is not supportedArithmeticException
- if numeric overflow occurs
-
format
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
- the formatter to use, not null- Returns:
- the formatted hour-minute string, not null
- Throws:
DateTimeException
- if an error occurs during printing
-
atDate
public LocalDateTime atDate(LocalDate date)
Combines this time with a date to create aLocalDateTime
.This returns a
LocalDateTime
formed from this time at the specified date. All possible combinations of date and time are valid.- Parameters:
date
- the date to combine with, not null- Returns:
- the local date-time formed from this time and the specified date, not null
-
atOffset
public OffsetTime atOffset(ZoneOffset offset)
Combines this time with an offset to create anOffsetTime
.This returns an
OffsetTime
formed from this time at the specified offset. All possible combinations of time and offset are valid.- Parameters:
offset
- the offset to combine with, not null- Returns:
- the offset time formed from this time and the specified offset, not null
-
toLocalTime
public LocalTime toLocalTime()
Returns the equivalentLocalTime
.This returns a
LocalTime
formed from this hour and minute.- Returns:
- the equivalent local time, not null
-
compareTo
public int compareTo(HourMinute other)
Compares this hour-minute to anotherThe 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
.- Specified by:
compareTo
in interfaceComparable<HourMinute>
- Parameters:
other
- the other hour-minute to compare to, not null- Returns:
- the comparator value, negative if less, positive if greater
-
isAfter
public boolean isAfter(HourMinute other)
Is this hour-minute after the specified hour-minute.- Parameters:
other
- the other hour-minute to compare to, not null- Returns:
- true if this is after the specified hour-minute
-
isBefore
public boolean isBefore(HourMinute other)
Is this hour-minute before the specified hour-minute.- Parameters:
other
- the other hour-minute to compare to, not null- Returns:
- true if this point is before the specified hour-minute
-
equals
public boolean equals(Object obj)
Checks if this hour-minute is equal to another hour-minute.The comparison is based on the time-line position of the hour-minute.
-
hashCode
public int hashCode()
A hash code for this hour-minute.
-
-