Package org.threeten.bp.zone

Class ZoneRulesBuilder

java.lang.Object

org.threeten.bp.zone.ZoneRulesBuilder

class ZoneRulesBuilder
extends java.lang.Object

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	ZoneRulesBuilder.TZRule	A definition of the way a local time can be converted to an offset time.
(package private) class	ZoneRulesBuilder.TZWindow	A definition of a window in the time-line.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.Object,java.lang.Object>	deduplicateMap	A map for deduplicating the output.
private java.util.List<ZoneRulesBuilder.TZWindow>	windowList	The list of windows.

Constructor Summary

Constructors

Constructor	Description
ZoneRulesBuilder()	Constructs an instance of the builder that can be used to create zone rules.

Method Summary

Modifier and Type	Method	Description
ZoneRulesBuilder	addRuleToWindow(int startYear, int endYear, Month month, int dayOfMonthIndicator, DayOfWeek dayOfWeek, LocalTime time, boolean timeEndOfDay, ZoneOffsetTransitionRule.TimeDefinition timeDefinition, int savingAmountSecs)	Adds a multi-year transition rule to the current window.
(package private) ZoneRulesBuilder	addRuleToWindow(int startYear, int endYear, Month month, int dayOfMonthIndicator, DayOfWeek dayOfWeek, LocalTime time, int adjustDays, ZoneOffsetTransitionRule.TimeDefinition timeDefinition, int savingAmountSecs)
ZoneRulesBuilder	addRuleToWindow(int year, Month month, int dayOfMonthIndicator, LocalTime time, boolean timeEndOfDay, ZoneOffsetTransitionRule.TimeDefinition timeDefinition, int savingAmountSecs)	Adds a single transition rule to the current window.
ZoneRulesBuilder	addRuleToWindow(LocalDateTime transitionDateTime, ZoneOffsetTransitionRule.TimeDefinition timeDefinition, int savingAmountSecs)	Adds a single transition rule to the current window.
ZoneRulesBuilder	addWindow(ZoneOffset standardOffset, LocalDateTime until, ZoneOffsetTransitionRule.TimeDefinition untilDefinition)	Adds a window to the builder that can be used to filter a set of rules.
ZoneRulesBuilder	addWindowForever(ZoneOffset standardOffset)	Adds a window that applies until the end of time to the builder that can be used to filter a set of rules.
(package private) <T> T	deduplicate(T object)	Deduplicates an object instance.
ZoneRulesBuilder	setFixedSavingsToWindow(int fixedSavingAmountSecs)	Sets the previously added window to have fixed savings.
ZoneRules	toRules(java.lang.String zoneId)	Completes the build converting the builder to a set of time-zone rules.
(package private) ZoneRules	toRules(java.lang.String zoneId, java.util.Map<java.lang.Object,java.lang.Object> deduplicateMap)	Completes the build converting the builder to a set of time-zone rules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

windowList

private java.util.List<ZoneRulesBuilder.TZWindow> windowList

The list of windows.

deduplicateMap

private java.util.Map<java.lang.Object,java.lang.Object> deduplicateMap

A map for deduplicating the output.

Constructor Detail

ZoneRulesBuilder

public ZoneRulesBuilder()

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.

Method Detail

addWindow

public ZoneRulesBuilder addWindow(ZoneOffset standardOffset,
                                  LocalDateTime until,
                                  ZoneOffsetTransitionRule.TimeDefinition untilDefinition)

Adds a window 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.

Each window must be added sequentially, as the start instant of the window is derived from the until instant of the previous window.

Parameters:

standardOffset - the standard offset, not null

until - the date-time that the offset applies until, not null

untilDefinition - the time type for the until date-time, not null

Returns:

this, for chaining

Throws:

java.lang.IllegalStateException - if the window order is invalid

addWindowForever

public ZoneRulesBuilder addWindowForever(ZoneOffset standardOffset)

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.

Parameters:

standardOffset - the standard offset, not null

Returns:

this, for chaining

Throws:

java.lang.IllegalStateException - if a forever window has already been added

setFixedSavingsToWindow

public ZoneRulesBuilder setFixedSavingsToWindow(int fixedSavingAmountSecs)

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.

Parameters:

fixedSavingAmountSecs - the amount of saving to use for the whole window, not null

Returns:

this, for chaining

Throws:

java.lang.IllegalStateException - if no window has yet been added

java.lang.IllegalStateException - if the window already has rules

addRuleToWindow

public ZoneRulesBuilder addRuleToWindow(LocalDateTime transitionDateTime,
                                        ZoneOffsetTransitionRule.TimeDefinition timeDefinition,
                                        int savingAmountSecs)

Adds a single transition rule to the current window.

This adds a rule such that the offset, expressed as a daylight savings amount, changes at the specified date-time.

Parameters:

transitionDateTime - the date-time that the transition occurs as defined by timeDefintion, not null

timeDefinition - the definition of how to convert local to actual time, not null

savingAmountSecs - the amount of saving from the standard offset after the transition in seconds

Returns:

this, for chaining

Throws:

java.lang.IllegalStateException - if no window has yet been added

java.lang.IllegalStateException - if the window already has fixed savings

java.lang.IllegalStateException - if the window has reached the maximum capacity of 2000 rules

addRuleToWindow

public ZoneRulesBuilder addRuleToWindow(int year,
                                        Month month,
                                        int dayOfMonthIndicator,
                                        LocalTime time,
                                        boolean timeEndOfDay,
                                        ZoneOffsetTransitionRule.TimeDefinition timeDefinition,
                                        int savingAmountSecs)

Adds a single transition rule to the current window.

This adds a rule such that the offset, expressed as a daylight savings amount, changes at the specified date-time.

Parameters:

year - the year of the transition, from MIN_VALUE to MAX_VALUE

month - the month of the transition, not null

dayOfMonthIndicator - the day-of-month of the transition, adjusted by dayOfWeek, from 1 to 31 adjusted later, or -1 to -28 adjusted earlier from the last day of the month

time - the time that the transition occurs as defined by timeDefintion, not null

timeEndOfDay - whether midnight is at the end of day

timeDefinition - the definition of how to convert local to actual time, not null

savingAmountSecs - the amount of saving from the standard offset after the transition in seconds

Returns:

this, for chaining

Throws:

DateTimeException - if a date-time field is out of range

java.lang.IllegalStateException - if no window has yet been added

java.lang.IllegalStateException - if the window already has fixed savings

java.lang.IllegalStateException - if the window has reached the maximum capacity of 2000 rules

addRuleToWindow

public ZoneRulesBuilder addRuleToWindow(int startYear,
                                        int endYear,
                                        Month month,
                                        int dayOfMonthIndicator,
                                        DayOfWeek dayOfWeek,
                                        LocalTime time,
                                        boolean timeEndOfDay,
                                        ZoneOffsetTransitionRule.TimeDefinition timeDefinition,
                                        int savingAmountSecs)

Adds a multi-year transition rule to the current window.

This adds a rule such that the offset, expressed as a daylight savings amount, changes at the specified date-time for each year in the range.

Parameters:

startYear - the start year of the rule, from MIN_VALUE to MAX_VALUE

endYear - the end year of the rule, from MIN_VALUE to MAX_VALUE

month - the month of the transition, not null

dayOfMonthIndicator - the day-of-month of the transition, adjusted by dayOfWeek, from 1 to 31 adjusted later, or -1 to -28 adjusted earlier from the last day of the month

dayOfWeek - the day-of-week to adjust to, null if day-of-month should not be adjusted

time - the time that the transition occurs as defined by timeDefintion, not null

timeEndOfDay - whether midnight is at the end of day

timeDefinition - the definition of how to convert local to actual time, not null

savingAmountSecs - the amount of saving from the standard offset after the transition in seconds

Returns:

this, for chaining

Throws:

DateTimeException - if a date-time field is out of range

java.lang.IllegalArgumentException - if the day of month indicator is invalid

java.lang.IllegalArgumentException - if the end of day midnight flag does not match the time

java.lang.IllegalStateException - if no window has yet been added

java.lang.IllegalStateException - if the window already has fixed savings

java.lang.IllegalStateException - if the window has reached the maximum capacity of 2000 rules

addRuleToWindow

ZoneRulesBuilder addRuleToWindow(int startYear,
                                 int endYear,
                                 Month month,
                                 int dayOfMonthIndicator,
                                 DayOfWeek dayOfWeek,
                                 LocalTime time,
                                 int adjustDays,
                                 ZoneOffsetTransitionRule.TimeDefinition timeDefinition,
                                 int savingAmountSecs)

toRules

public ZoneRules toRules(java.lang.String zoneId)

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.

Parameters:

zoneId - the time-zone ID, not null

Returns:

the zone rules, not null

Throws:

java.lang.IllegalStateException - if no windows have been added

java.lang.IllegalStateException - if there is only one rule defined as being forever for any given window

toRules

ZoneRules toRules(java.lang.String zoneId,
                  java.util.Map<java.lang.Object,java.lang.Object> deduplicateMap)

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.

Parameters:

zoneId - the time-zone ID, not null

deduplicateMap - a map for deduplicating the values, not null

Returns:

the zone rules, not null

Throws:

java.lang.IllegalStateException - if no windows have been added

java.lang.IllegalStateException - if there is only one rule defined as being forever for any given window

deduplicate

<T> T deduplicate(T object)

Deduplicates an object instance.

Type Parameters:

T - the generic type

Parameters:

object - the object to deduplicate

Returns:

the deduplicated object