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(boolean positive, int hour, int minute)
UtcOffset(long millis)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getMillis() Gets the offset in milliseconds.
int	hashCode()
static UtcOffset	parse(String text) Parses a UTC offset from a string.
static UtcOffset	parse(TimeZone timezone) Creates a UTC offset from a TimeZone object.
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(boolean positive,
         int hour,
         int minute)

Parameters:

positive - true if the offset is positive, false if it is negative

hour - the hour component of the offset (the sign of this integer is ignored)

minute - the minute component of the offset (the sign of this integer is ignored)

UtcOffset

public UtcOffset(long millis)

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

parse

public static UtcOffset parse(TimeZone timezone)

Creates a UTC offset from a TimeZone object.

Parameters:

timezone - the timezone

Returns:

the UTC offset

getMillis

public long getMillis()

Gets the offset in milliseconds.

Returns:

the offset in milliseconds

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object