org.joda.time.tz

Class CachedDateTimeZone

Implemented Interfaces:
Serializable

public class CachedDateTimeZone
extends DateTimeZone

Improves the performance of requesting time zone offsets and name keys by caching the results. Time zones that have simple rules or are fixed should not be cached, as it is unlikely to improve performance.

CachedDateTimeZone is thread-safe and immutable.

Author:
Brian S O'Neill
Since:
1.0

Field Summary

Fields inherited from class org.joda.time.DateTimeZone

UTC

Method Summary

boolean
equals(Object obj)
Compare this datetime zone with another.
static CachedDateTimeZone
forZone(DateTimeZone zone)
Returns a new CachedDateTimeZone unless given zone is already cached.
String
getNameKey(long instant)
Returns a non-localized name that is unique to this time zone.
int
getOffset(long instant)
Gets the millisecond offset to add to UTC to get local time.
int
getStandardOffset(long instant)
Gets the standard millisecond offset to add to UTC to get local time, when standard time is in effect.
DateTimeZone
getUncachedZone()
Returns the DateTimeZone being wrapped.
int
hashCode()
Gets a hash code compatable with equals.
boolean
isFixed()
Returns true if this time zone has no transitions.
long
nextTransition(long instant)
Advances the given instant to where the time zone offset or name changes.
long
previousTransition(long instant)
Retreats the given instant to where the time zone offset or name changes.

Methods inherited from class org.joda.time.DateTimeZone

convertLocalToUTC, convertUTCToLocal, equals, forID, forOffsetHours, forOffsetHoursMinutes, forOffsetMillis, forTimeZone, getAvailableIDs, getDefault, getID, getMillisKeepLocal, getName, getName, getNameKey, getNameProvider, getOffset, getOffset, getOffsetFromLocal, getProvider, getShortName, getShortName, getStandardOffset, hashCode, isFixed, isLocalDateTimeGap, isStandardOffset, nextTransition, previousTransition, setDefault, setNameProvider, setProvider, toString, toTimeZone, writeReplace

Method Details

equals

public boolean equals(Object obj)
Compare this datetime zone with another.
Overrides:
equals in interface DateTimeZone
Parameters:
Returns:
true if equal, based on the ID and all internal rules

forZone

public static CachedDateTimeZone forZone(DateTimeZone zone)
Returns a new CachedDateTimeZone unless given zone is already cached.

getNameKey

public String getNameKey(long instant)
Returns a non-localized name that is unique to this time zone. It can be combined with id to form a unique key for fetching localized names.
Overrides:
getNameKey in interface DateTimeZone
Parameters:
instant - milliseconds from 1970-01-01T00:00:00Z to get the name for
Returns:
name key or null if id should be used for names

getOffset

public int getOffset(long instant)
Gets the millisecond offset to add to UTC to get local time.
Overrides:
getOffset in interface DateTimeZone
Parameters:
instant - milliseconds from 1970-01-01T00:00:00Z to get the offset for
Returns:
the millisecond offset to add to UTC to get local time

getStandardOffset

public int getStandardOffset(long instant)
Gets the standard millisecond offset to add to UTC to get local time, when standard time is in effect.
Overrides:
getStandardOffset in interface DateTimeZone
Parameters:
instant - milliseconds from 1970-01-01T00:00:00Z to get the offset for
Returns:
the millisecond offset to add to UTC to get local time

getUncachedZone

public DateTimeZone getUncachedZone()
Returns the DateTimeZone being wrapped.

hashCode

public int hashCode()
Gets a hash code compatable with equals.
Overrides:
hashCode in interface DateTimeZone
Returns:
suitable hashcode

isFixed

public boolean isFixed()
Returns true if this time zone has no transitions.
Overrides:
isFixed in interface DateTimeZone
Returns:
true if no transitions

nextTransition

public long nextTransition(long instant)
Advances the given instant to where the time zone offset or name changes. If the instant returned is exactly the same as passed in, then no changes occur after the given instant.
Overrides:
nextTransition in interface DateTimeZone
Parameters:
instant - milliseconds from 1970-01-01T00:00:00Z
Returns:
milliseconds from 1970-01-01T00:00:00Z

previousTransition

public long previousTransition(long instant)
Retreats the given instant to where the time zone offset or name changes. If the instant returned is exactly the same as passed in, then no changes occur before the given instant.
Overrides:
previousTransition in interface DateTimeZone
Parameters:
instant - milliseconds from 1970-01-01T00:00:00Z
Returns:
milliseconds from 1970-01-01T00:00:00Z

Copyright (c) 2001-2006 - Joda.org