javax.time.calendar.field

Class MinuteOfHour

java.lang.Object

javax.time.calendar.field.MinuteOfHour

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MinuteOfHour>, Calendrical, CalendricalMatcher, TimeAdjuster

public final class MinuteOfHour
extends java.lang.Object
implements Calendrical, java.lang.Comparable<MinuteOfHour>, TimeAdjuster, CalendricalMatcher, java.io.Serializable

A representation of a minute-of-hour in the ISO-8601 calendar system.

MinuteOfHour is an immutable time field that can only store a minute-of-hour. It is a type-safe way of representing a minute-of-hour in an application.

Static factory methods allow you to construct instances. The minute-of-hour may be queried using getValue().

MinuteOfHour is immutable and thread-safe.

Author:

Michael Nascimento Santos, Stephen Colebourne

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
LocalTime	adjustTime(LocalTime time) Adjusts a time to have the the minute-of-hour represented by this object, returning a new time.
int	compareTo(MinuteOfHour otherMinuteOfHour) Compares this minute-of-hour instance to another.
boolean	equals(java.lang.Object otherMinuteOfHour) Is this instance equal to that specified, evaluating the minute-of-hour.
<T> T	get(CalendricalRule<T> rule) Gets the value of the specified calendrical rule.
int	getValue() Gets the minute-of-hour value.
int	hashCode() A hash code for the minute-of-hour object.
boolean	matchesCalendrical(Calendrical calendrical) Checks if the minute-of-hour extracted from the calendrical matches this.
static MinuteOfHour	minuteOfHour(Calendrical calendrical) Obtains an instance of MinuteOfHour from a calendrical.
static MinuteOfHour	minuteOfHour(int minuteOfHour) Obtains an instance of MinuteOfHour.
static DateTimeFieldRule<java.lang.Integer>	rule() Gets the rule that defines how the minute-of-hour field operates.
java.lang.String	toString() A string describing the minute-of-hour object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

rule

public static DateTimeFieldRule<java.lang.Integer> rule()

Gets the rule that defines how the minute-of-hour field operates.

The rule provides access to the minimum and maximum values, and a generic way to access values within a calendrical.

Returns:

the minute-of-hour rule, never null

minuteOfHour

public static MinuteOfHour minuteOfHour(int minuteOfHour)

Obtains an instance of MinuteOfHour.

Parameters:

minuteOfHour - the minute-of-hour to represent, from 0 to 59

Returns:

the created MinuteOfHour

Throws:

IllegalCalendarFieldValueException - if the minuteOfHour is invalid

minuteOfHour

public static MinuteOfHour minuteOfHour(Calendrical calendrical)

Obtains an instance of MinuteOfHour from a calendrical.

This can be used extract the minute-of-hour value directly from any implementation of Calendrical, including those in other calendar systems.

Parameters:

calendrical - the calendrical to extract from, not null

Returns:

the MinuteOfHour instance, never null

Throws:

UnsupportedRuleException - if the minute-of-hour cannot be obtained

get

public <T> T get(CalendricalRule<T> rule)

Gets the value of the specified calendrical rule.

This method queries the value of the specified calendrical rule. If the value cannot be returned for the rule from this instance then null will be returned.

Specified by:

get in interface Calendrical

Parameters:

rule - the rule to use, not null

Returns:

the value for the rule, null if the value cannot be returned

getValue

public int getValue()

Gets the minute-of-hour value.

Returns:

the minute-of-hour, from 0 to 59

matchesCalendrical

public boolean matchesCalendrical(Calendrical calendrical)

Checks if the minute-of-hour extracted from the calendrical matches this.

Specified by:

matchesCalendrical in interface CalendricalMatcher

Parameters:

calendrical - the calendrical to match, not null

Returns:

true if the calendrical matches, false otherwise

adjustTime

public LocalTime adjustTime(LocalTime time)

Adjusts a time to have the the minute-of-hour represented by this object, returning a new time.

Only the minute-of-hour field is adjusted in the result. The other time fields are unaffected.

This instance is immutable and unaffected by this method call.

Specified by:

adjustTime in interface TimeAdjuster

Parameters:

time - the time to be adjusted, not null

Returns:

the adjusted time, never null

compareTo

public int compareTo(MinuteOfHour otherMinuteOfHour)

Compares this minute-of-hour instance to another.

Specified by:

compareTo in interface java.lang.Comparable<MinuteOfHour>

Parameters:

otherMinuteOfHour - the other minute-of-hour instance, not null

Returns:

the comparator value, negative if less, positive if greater

Throws:

java.lang.NullPointerException - if otherMinuteOfHour is null

equals

public boolean equals(java.lang.Object otherMinuteOfHour)

Is this instance equal to that specified, evaluating the minute-of-hour.

Overrides:

equals in class java.lang.Object

Parameters:

otherMinuteOfHour - the other minute-of-hour instance, null returns false

Returns:

true if the minute-of-hour is the same

hashCode

public int hashCode()

A hash code for the minute-of-hour object.

Overrides:

hashCode in class java.lang.Object

Returns:

a suitable hash code

toString

public java.lang.String toString()

A string describing the minute-of-hour object.

Overrides:

toString in class java.lang.Object

Returns:

a string describing this object