Class ZoneRulesBuilder
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.
TransitionRulesBuilder is a mutable class used to create instances of TimeZone. It must only be used from a single thread. The created TimeZone instances are immutable and thread-safe.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
A definition of the way a local time can be converted to an offset time.(package private) class
A definition of the way a local time can be converted to an offset time.(package private) class
A definition of a window in the time-line. -
Field Summary
FieldsModifier and TypeFieldDescriptionA map for deduplicating the output.private static final LocalDateTime
The maximum date-time.private static final long
A serialization identifier for this class.private List<ZoneRulesBuilder.TZWindow>
The list of windows. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an instance of the builder that can be used to create zone rules. -
Method Summary
Modifier and TypeMethodDescriptionaddRuleToWindow
(int startYear, int endYear, MonthOfYear month, int dayOfMonthIndicator, DayOfWeek dayOfWeek, LocalTime time, boolean timeEndOfDay, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount) Adds a multi-year transition rule to the current window.addRuleToWindow
(int year, MonthOfYear month, int dayOfMonthIndicator, LocalTime time, boolean timeEndOfDay, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount) Adds a single transition rule to the current window.addRuleToWindow
(LocalDateTime dateTime, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount) Adds a single transition rule to the current window.addWindow
(ZoneOffset standardOffset, LocalDateTime until, ZoneRulesBuilder.TimeDefinition untilDefinition) Adds a window to the builder that can be used to filter a set of rules.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.private static void
checkNotNull
(Object object, String errorMessage) Validates that the input value is not null.(package private) <T> T
deduplicate
(T object) Deduplicates an object instance.setFixedSavingsToWindow
(Period fixedSavingAmount) Sets the previously added window to have fixed savings.Completes the build converting the builder to a set of time-zone rules.(package private) ZoneRules
Completes the build converting the builder to a set of time-zone rules.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDA serialization identifier for this class.- See Also:
-
MAX_DATE_TIME
The maximum date-time. -
windowList
The list of windows. -
deduplicateMap
A map for deduplicating the output.
-
-
Constructor Details
-
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 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 alist of rules
.
-
-
Method Details
-
checkNotNull
Validates that the input value is not null.- Parameters:
object
- the object to checkerrorMessage
- the error to throw- Throws:
NullPointerException
- if the object is null
-
addWindow
public ZoneRulesBuilder addWindow(ZoneOffset standardOffset, LocalDateTime until, ZoneRulesBuilder.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 nulluntil
- the date-time that the offset applies until, not nulluntilDefinition
- the time type for the until date-time, not null- Returns:
- this, for chaining
- Throws:
IllegalStateException
- if the window order is invalid
-
addWindowForever
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:
IllegalStateException
- if a forever window has already been added
-
setFixedSavingsToWindow
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:
fixedSavingAmount
- the amount of saving to use for the whole window, not null- Returns:
- this, for chaining
- Throws:
IllegalStateException
- if no window has yet been addedIllegalStateException
- if the window already has rules
-
addRuleToWindow
public ZoneRulesBuilder addRuleToWindow(LocalDateTime dateTime, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount) 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:
dateTime
- the date-time that the transition occurs as defined by timeDefintion, not nulltimeDefinition
- the definition of how to convert local to actual time, not nullsavingAmount
- the amount of saving from the standard offset after the transition, not null- Returns:
- this, for chaining
- Throws:
IllegalStateException
- if no window has yet been addedIllegalStateException
- if the window already has fixed savingsIllegalStateException
- if the window has reached the maximum capacity of 2000 rules
-
addRuleToWindow
public ZoneRulesBuilder addRuleToWindow(int year, MonthOfYear month, int dayOfMonthIndicator, LocalTime time, boolean timeEndOfDay, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount) 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_YEAR to MAX_YEARmonth
- the month of the transition, not nulldayOfMonthIndicator
- 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 monthtime
- the time that the transition occurs as defined by timeDefintion, not nulltimeEndOfDay
- whether midnight is at the end of daytimeDefinition
- the definition of how to convert local to actual time, not nullsavingAmount
- the amount of saving from the standard offset after the transition, not null- Returns:
- this, for chaining
- Throws:
IllegalCalendarFieldValueException
- if a date-time field is out of rangeIllegalStateException
- if no window has yet been addedIllegalStateException
- if the window already has fixed savingsIllegalStateException
- if the window has reached the maximum capacity of 2000 rules
-
addRuleToWindow
public ZoneRulesBuilder addRuleToWindow(int startYear, int endYear, MonthOfYear month, int dayOfMonthIndicator, DayOfWeek dayOfWeek, LocalTime time, boolean timeEndOfDay, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount) 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_YEAR to MAX_YEARendYear
- the end year of the rule, from MIN_YEAR to MAX_YEARmonth
- the month of the transition, not nulldayOfMonthIndicator
- 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 monthdayOfWeek
- the day-of-week to adjust to, null if day-of-month should not be adjustedtime
- the time that the transition occurs as defined by timeDefintion, not nulltimeEndOfDay
- whether midnight is at the end of daytimeDefinition
- the definition of how to convert local to actual time, not nullsavingAmount
- the amount of saving from the standard offset after the transition, not null- Returns:
- this, for chaining
- Throws:
IllegalCalendarFieldValueException
- if a date-time field is out of rangeIllegalArgumentException
- if the day of month indicator is invalidIllegalArgumentException
- if the end of day midnight flag does not match the timeIllegalStateException
- if no window has yet been addedIllegalStateException
- if the window already has fixed savingsIllegalStateException
- if the window has reached the maximum capacity of 2000 rules
-
toRules
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:
id
- the time-zone id, not null- Returns:
- the zone rules, never null
- Throws:
IllegalStateException
- if no windows have been addedIllegalStateException
- if there is only one rule defined as being forever for any given window
-
toRules
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:
id
- the time-zone id, not nulldeduplicateMap
- a map for deduplicating the values, not null- Returns:
- the zone rules, never null
- Throws:
IllegalStateException
- if no windows have been addedIllegalStateException
- 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
-