javax.time.calendar.field

Class SecondOfMinute

java.lang.Object

javax.time.calendar.field.SecondOfMinute

All Implemented Interfaces:

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

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

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

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

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

SecondOfMinute 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 second-of-minute represented by this object, returning a new time.
int	compareTo(SecondOfMinute otherSecondOfMinute) Compares this second-of-minute instance to another.
boolean	equals(java.lang.Object otherSecondOfMinute) Is this instance equal to that specified, evaluating the second-of-minute.
<T> T	get(CalendricalRule<T> rule) Gets the value of the specified calendrical rule.
int	getValue() Gets the second-of-minute value.
int	hashCode() A hash code for the second-of-minute object.
boolean	matchesCalendrical(Calendrical calendrical) Checks if the second-of-minute extracted from the calendrical matches this.
static DateTimeFieldRule<java.lang.Integer>	rule() Gets the rule that defines how the second-of-minute field operates.
static SecondOfMinute	secondOfMinute(Calendrical calendrical) Obtains an instance of SecondOfMinute from a calendrical.
static SecondOfMinute	secondOfMinute(int secondOfMinute) Obtains an instance of SecondOfMinute.
java.lang.String	toString() A string describing the second-of-minute 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 second-of-minute field operates.

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

Returns:

the second-of-minute rule, never null

secondOfMinute

public static SecondOfMinute secondOfMinute(int secondOfMinute)

Obtains an instance of SecondOfMinute.

Parameters:

secondOfMinute - the second-of-minute to represent, from 0 to 59

Returns:

the created SecondOfMinute

Throws:

IllegalCalendarFieldValueException - if the secondOfMinute is invalid

secondOfMinute

public static SecondOfMinute secondOfMinute(Calendrical calendrical)

Obtains an instance of SecondOfMinute from a calendrical.

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

Parameters:

calendrical - the calendrical to extract from, not null

Returns:

the SecondOfMinute instance, never null

Throws:

UnsupportedRuleException - if the second-of-minute 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 second-of-minute value.

Returns:

the second-of-minute, from 0 to 59

matchesCalendrical

public boolean matchesCalendrical(Calendrical calendrical)

Checks if the second-of-minute 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 second-of-minute represented by this object, returning a new time.

Only the second-of-minute 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(SecondOfMinute otherSecondOfMinute)

Compares this second-of-minute instance to another.

Specified by:

compareTo in interface java.lang.Comparable<SecondOfMinute>

Parameters:

otherSecondOfMinute - the other second-of-minute instance, not null

Returns:

the comparator value, negative if less, positive if greater

Throws:

java.lang.NullPointerException - if otherSecondOfMinute is null

equals

public boolean equals(java.lang.Object otherSecondOfMinute)

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

Overrides:

equals in class java.lang.Object

Parameters:

otherSecondOfMinute - the other second-of-minute instance, null returns false

Returns:

true if the second-of-minute is the same

hashCode

public int hashCode()

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

Overrides:

hashCode in class java.lang.Object

Returns:

a suitable hash code

toString

public java.lang.String toString()

A string describing the second-of-minute object.

Overrides:

toString in class java.lang.Object

Returns:

a string describing this object