public class ZoneRulesBuilder extends Object
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:
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.
Modifier and Type | Class and Description |
---|---|
static class |
ZoneRulesBuilder.TimeDefinition
A definition of the way a local time can be converted to an offset time.
|
Constructor and Description |
---|
ZoneRulesBuilder()
Constructs an instance of the builder that can be used to create zone rules.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
ZoneRulesBuilder |
addRuleToWindow(LocalDateTime dateTime,
ZoneRulesBuilder.TimeDefinition timeDefinition,
Period savingAmount)
Adds a single transition rule to the current window.
|
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.
|
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.
|
ZoneRulesBuilder |
setFixedSavingsToWindow(Period fixedSavingAmount)
Sets the previously added window to have fixed savings.
|
ZoneRules |
toRules(String id)
Completes the build converting the builder to a set of time-zone rules.
|
public ZoneRulesBuilder()
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 a
list of rules
.
public ZoneRulesBuilder addWindow(ZoneOffset standardOffset, LocalDateTime until, ZoneRulesBuilder.TimeDefinition untilDefinition)
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.
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 nullIllegalStateException
- if the window order is invalidpublic ZoneRulesBuilder addWindowForever(ZoneOffset standardOffset)
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 nullIllegalStateException
- if a forever window has already been addedpublic ZoneRulesBuilder setFixedSavingsToWindow(Period fixedSavingAmount)
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.
fixedSavingAmount
- the amount of saving to use for the whole window, not nullIllegalStateException
- if no window has yet been addedIllegalStateException
- if the window already has rulespublic ZoneRulesBuilder addRuleToWindow(LocalDateTime dateTime, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount)
This adds a rule such that the offset, expressed as a daylight savings amount, changes at the specified date-time.
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 nullIllegalStateException
- if no window has yet been addedIllegalStateException
- if the window already has fixed savingsIllegalStateException
- if the window has reached the maximum capacity of 2000 rulespublic ZoneRulesBuilder addRuleToWindow(int year, MonthOfYear month, int dayOfMonthIndicator, LocalTime time, boolean timeEndOfDay, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount)
This adds a rule such that the offset, expressed as a daylight savings amount, changes at the specified date-time.
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 nullIllegalCalendarFieldValueException
- 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 rulespublic ZoneRulesBuilder addRuleToWindow(int startYear, int endYear, MonthOfYear month, int dayOfMonthIndicator, DayOfWeek dayOfWeek, LocalTime time, boolean timeEndOfDay, ZoneRulesBuilder.TimeDefinition timeDefinition, Period savingAmount)
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.
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 nullIllegalCalendarFieldValueException
- 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 rulespublic ZoneRules toRules(String id)
Calling this method alters the state of the builder. Further rules should not be added to this builder once this method is called.
id
- the time-zone id, not nullIllegalStateException
- if no windows have been addedIllegalStateException
- if there is only one rule defined as being forever for any given windowCopyright © 2014. All rights reserved.