abstract class ZoneRulesProvider extends AnyRef
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.
- Alphabetic
- By Inheritance
- ZoneRulesProvider
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ZoneRulesProvider()
- Attributes
- protected
Abstract Value Members
- abstract def provideRules(regionId: String, forCaching: Boolean): ZoneRules
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.
- regionId
the time-zone region ID, not null
- returns
the rules, not null
- Attributes
- protected
- Exceptions thrown
DateTimeExceptionif rules cannot be obtained
- abstract def provideVersions(zoneId: String): NavigableMap[String, ZoneRules]
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.
- zoneId
the zone region ID as used by { @code ZoneId}, not null
- returns
a modifiable copy of the history of the rules for the ID, sorted from oldest to newest, not null
- Attributes
- protected
- Exceptions thrown
ZoneRulesExceptionif history cannot be obtained for the zone ID
- abstract def provideZoneIds: Set[String]
SPI method to get the available zone IDs.
SPI method to get the available zone IDs.
This obtains the IDs that this
ZoneRulesProviderprovides. 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.
- returns
the unmodifiable set of region IDs being provided, not null
- Attributes
- protected
- Exceptions thrown
ZoneRulesExceptionif a problem occurs while providing the IDs
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def provideRefresh: Boolean
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.
- returns
true if the rules were updated
- Attributes
- protected
- Exceptions thrown
DateTimeExceptionif an error occurs during the refresh
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()