SPI method to get the rules for the zone ID.
SPI method to get the rules for the zone ID.
This loads the rules for the region and version specified. The version may be null to indicate the "latest" version.
the time-zone region ID, not null
the rules, not null
if rules cannot be obtained
SPI method to get the history of rules for the zone ID.
SPI method to get the history of rules for the zone ID.
This returns a map of historical rules keyed by a version string. The exact meaning and format of the version is provider specific. The version must follow lexicographical order, thus the returned map will be order from the oldest known rules to the newest available rules. The default 'TZDB' group uses version numbering consisting of the year followed by a letter, such as '2009e' or '2012f'.
Implementations must provide a result for each valid zone ID, however they do not have to provide a history of rules. Thus the map will always contain one element, and will only contain more than one element if historical rule information is available.
The returned versions remain available and valid for the lifetime of the application. A dynamic provider may increase the set of versions as more data becomes available.
the zone region ID as used by { @code ZoneId}, not null
a modifiable copy of the history of the rules for the ID, sorted from oldest to newest, not null
if history cannot be obtained for the zone ID
SPI method to get the available zone IDs.
SPI method to get the available zone IDs.
This obtains the IDs that this ZoneRulesProvider provides.
A provider should provide data for at least one region.
The returned regions remain available and valid for the lifetime of the application. A dynamic provider may increase the set of regions as more data becomes available.
the unmodifiable set of region IDs being provided, not null
if a problem occurs while providing the IDs
SPI method to refresh the rules from the underlying data provider.
SPI method to refresh the rules from the underlying data provider.
This method provides the opportunity for a provider to dynamically recheck the underlying data provider to find the latest rules. This could be used to load new rules without stopping the JVM. Dynamic behavior is entirely optional and most providers do not support it.
This implementation returns false.
true if the rules were updated
if an error occurs during the refresh
Provider of time-zone rules to the system.
This class manages the configuration of time-zone rules. The static methods provide the public API that can be used to manage the providers. The abstract methods provide the SPI that allows rules to be provided.
Rules are looked up primarily by zone ID, as used by
ZoneId. Only zone region IDs may be used, zone offset IDs are not used here.Time-zone rules are political, thus the data can change at any time. Each provider will provide the latest rules for each zone ID, but they may also provide the history of how the rules changed.
Specification for implementors
This interface is a service provider that can be called by multiple threads. Implementations must be immutable and thread-safe.
Providers must ensure that once a rule has been seen by the application, the rule must continue to be available.
Many systems would like to update time-zone rules dynamically without stopping the JVM. When examined in detail, this is a complex problem. Providers may choose to handle dynamic updates, however the default provider does not.