ZoneRulesBuilder

A mutable builder used to create all the rules for a historic time-zone.

The rules of a time-zone describe how the offset changes over time. The rules are created by building windows on the time-line within which the different rules apply. The rules may be one of two kinds:

Fixed savings - A single fixed amount of savings from the standard offset will apply.
Rules - A set of one or more rules describe how daylight savings changes during the window.

Specification for implementors

This class is a mutable builder used to create zone instances. It must only be used from a single thread. The created instances are immutable and thread-safe.

Constructs an instance of the builder that can be used to create zone rules.

The builder is used by adding one or more windows representing portions of the time-line. The standard offset from UTC/Greenwich will be constant within a window, although two adjacent windows can have the same standard offset.

Within each window, there can either be a fixed savings amount or a list of rules.

Linear Supertypes

AnyRef, Any

Instance Constructors

new ZoneRulesBuilder()

Type Members

class TZRule extends AnyRef

A definition of the way a local time can be converted to an offset time.
A definition of the way a local time can be converted to an offset time.

Attributes
protected[java.time.zone]
class TZRuleComparator extends Comparator[TZRule]

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
def addWindowForever(standardOffset: ZoneOffset): ZoneRulesBuilder

Adds a window that applies until the end of time to the builder that can be used to filter a set of rules.
Adds a window that applies until the end of time to the builder that can be used to filter a set of rules.
This method defines and adds a window to the zone where the standard offset is specified. The window limits the effect of subsequent additions of transition rules or fixed savings. If neither rules or fixed savings are added to the window then the window will default to no savings.
This must be added after all other windows. No more windows can be added after this one.
standardOffset
the standard offset, not null
returns
this, for chaining

Exceptions thrown
IllegalStateException if a forever window has already been added
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): 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[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def setFixedSavingsToWindow(fixedSavingAmountSecs: Int): ZoneRulesBuilder

Sets the previously added window to have fixed savings.
Sets the previously added window to have fixed savings.
Setting a window to have fixed savings simply means that a single daylight savings amount applies throughout the window. The window could be small, such as a single summer, or large, such as a multi-year daylight savings.
A window can either have fixed savings or rules but not both.
fixedSavingAmountSecs
the amount of saving to use for the whole window, not null
returns
this, for chaining

Exceptions thrown
IllegalStateException if the window already has rules
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toRules(zoneId: String): ZoneRules

Completes the build converting the builder to a set of time-zone rules.
Completes the build converting the builder to a set of time-zone rules.
Calling this method alters the state of the builder. Further rules should not be added to this builder once this method is called.
zoneId
the time-zone ID, not null
returns
the zone rules, not null

Exceptions thrown
IllegalStateException if there is only one rule defined as being forever for any given window
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package zone

class ZoneRulesBuilder extends AnyRef

Specification for implementors

Instance Constructors

new ZoneRulesBuilder()

Type Members

class TZRule extends AnyRef

class TZRuleComparator extends Comparator[TZRule]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addWindowForever(standardOffset: ZoneOffset): ZoneRulesBuilder

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def setFixedSavingsToWindow(fixedSavingAmountSecs: Int): ZoneRulesBuilder

final def synchronized[T0](arg0: ⇒ T0): T0

def toRules(zoneId: String): ZoneRules

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped