biweekly.util

Class UtcOffset

java.lang.Object

biweekly.util.UtcOffset

public final class UtcOffset
extends Object

Represents a UTC offset.

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
UtcOffset(int millis) Creates a new UTC offset.
UtcOffset(int hour, int minute) Creates a new UTC offset.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getHour() Gets the hour component.
int	getMinute() Gets the minute component.
int	hashCode()
static UtcOffset	parse(String text) Parses a UTC offset from a string.
int	toMillis() Converts the offset to milliseconds.
String	toString() Converts this offset to its ISO string representation using "basic" format.
String	toString(boolean extended) Converts this offset to its ISO string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

UtcOffset

public UtcOffset(int hour,
         int minute)

Creates a new UTC offset.

Parameters:

hour - the hour component (may be negative)

minute - the minute component (must be between 0 and 59)

UtcOffset

public UtcOffset(int millis)

Creates a new UTC offset.

Parameters:

millis - the offset in milliseconds

Method Detail

parse

public static UtcOffset parse(String text)

Parses a UTC offset from a string.

Parameters:

text - the text to parse (e.g. "-0500")

Returns:

the parsed UTC offset

Throws:

IllegalArgumentException - if the text cannot be parsed

getHour

public int getHour()

Gets the hour component.

Returns:

the hour component

getMinute

public int getMinute()

Gets the minute component.

Returns:

the minute component

toString

public String toString()

Converts this offset to its ISO string representation using "basic" format.

Overrides:

toString in class Object

Returns:

the ISO string representation (e.g. "-0500")

toString

public String toString(boolean extended)

Converts this offset to its ISO string representation.

Parameters:

extended - true to use extended format (e.g. "-05:00"), false to use basic format (e.g. "-0500")

Returns:

the ISO string representation

toMillis

public int toMillis()

Converts the offset to milliseconds.

Returns:

the offset in milliseconds

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object