Package com.ibm.icu.util

Class BasicTimeZone

    • Constructor Detail

      • BasicTimeZone

        protected BasicTimeZone()
        Protected no arg constructor.

      • BasicTimeZone

        @Deprecated
protected BasicTimeZone​(String ID)
        Deprecated.
        This API is ICU internal only.
        Constructing a BasicTimeZone with the given time zone ID.
        Parameters:
        ID - the time zone ID.

    • Method Detail

      • getNextTransition

        public abstract TimeZoneTransition getNextTransition​(long base,
                                                     boolean inclusive)
        Returns the first time zone transition after the base time.

        Example code:{@.jcite com.ibm.icu.samples.util.timezone.BasicTimeZoneExample:---getNextTransitionExample}

        Parameters:
        base - The base time.
        inclusive - Whether the base time is inclusive or not.
        Returns:
        A Date holding the first time zone transition time after the given base time, or null if no time zone transitions are available after the base time.

      • getPreviousTransition

        public abstract TimeZoneTransition getPreviousTransition​(long base,
                                                         boolean inclusive)
        Returns the last time zone transition before the base time.

        Example code:{@.jcite com.ibm.icu.samples.util.timezone.BasicTimeZoneExample:---getPreviousTransitionExample}

        Parameters:
        base - The base time.
        inclusive - Whether the base time is inclusive or not.
        Returns:
        A Date holding the last time zone transition time before the given base time, or null if no time zone transitions are available before the base time.

      • hasEquivalentTransitions

        public boolean hasEquivalentTransitions​(TimeZone tz,
                                        long start,
                                        long end)
        Checks if the time zone has equivalent transitions in the time range. This method returns true when all of transition times, from/to standard offsets and DST savings used by this time zone match the other in the time range.

        Example code:{@.jcite com.ibm.icu.samples.util.timezone.BasicTimeZoneExample:---hasEquivalentTransitionsExample}

        Parameters:
        tz - The instance of TimeZone
        start - The start time of the evaluated time range (inclusive)
        end - The end time of the evaluated time range (inclusive)
        Returns:
        true if the other time zone has the equivalent transitions in the time range. When tz is not a BasicTimeZone, this method returns false.

      • hasEquivalentTransitions

        public boolean hasEquivalentTransitions​(TimeZone tz,
                                        long start,
                                        long end,
                                        boolean ignoreDstAmount)
        Checks if the time zone has equivalent transitions in the time range. This method returns true when all of transition times, from/to standard offsets and DST savings used by this time zone match the other in the time range.
        Parameters:
        tz - The instance of TimeZone
        start - The start time of the evaluated time range (inclusive)
        end - The end time of the evaluated time range (inclusive)
        ignoreDstAmount - When true, any transitions with only daylight saving amount changes will be ignored, except either of them is zero. For example, a transition from rawoffset 3:00/dstsavings 1:00 to rawoffset 2:00/dstsavings 2:00 is excluded from the comparison, but a transtion from rawoffset 2:00/dstsavings 1:00 to rawoffset 3:00/dstsavings 0:00 is included.
        Returns:
        true if the other time zone has the equivalent transitions in the time range. When tz is not a BasicTimeZone, this method returns false.

      • getTimeZoneRules

        public abstract TimeZoneRule[] getTimeZoneRules()
        Returns the array of TimeZoneRule which represents the rule of this time zone object. The first element in the result array will be the InitialTimeZoneRule instance for the initial rule. The rest will be either AnnualTimeZoneRule or TimeArrayTimeZoneRule instances representing transitions.
        Returns:
        The array of TimeZoneRule which represents this time zone.

      • getTimeZoneRules

        public TimeZoneRule[] getTimeZoneRules​(long start)
        Returns the array of TimeZoneRule which represents the rule of this time zone object since the specified start time. The first element in the result array will be the InitialTimeZoneRule instance for the initial rule. The rest will be either AnnualTimeZoneRule or TimeArrayTimeZoneRule instances representing transitions.

        Example code:{@.jcite com.ibm.icu.samples.util.timezone.BasicTimeZoneExample:---getTimeZoneRulesExample}

        Parameters:
        start - The start time (inclusive).
        Returns:
        The array of TimeZoneRule which represents this time zone since the start time.

      • getSimpleTimeZoneRulesNear

        public TimeZoneRule[] getSimpleTimeZoneRulesNear​(long date)
        Returns the array of TimeZoneRule which represents the rule of this time zone object near the specified date. Some applications are not capable to handle historic time zone rule changes. Also some applications can only handle certain type of rule definitions. This method returns either a single InitialTimeZoneRule if this time zone does not have any daylight saving time within 1 year from the specified time, or a pair of AnnualTimeZoneRule whose rule type is DateTimeRule.DOW for date and DateTimeRule.WALL_TIME for time with a single InitialTimeZoneRule representing the initial time, when this time zone observes daylight saving time near the specified date. Thus, the result may be only valid for dates around the specified date.
        Parameters:
        date - The date to be used for TimeZoneRule extraction.
        Returns:
        The array of TimeZoneRule, either a single InitialTimeZoneRule object, or a pair of AnnualTimeZoneRule with a single InitialTimeZoneRule. The first element in the array is always a InitialTimeZoneRule.

      • getOffsetFromLocal

        @Deprecated
public void getOffsetFromLocal​(long date,
                               int nonExistingTimeOpt,
                               int duplicatedTimeOpt,
                               int[] offsets)
        Deprecated.
        This API is ICU internal only.
        Returns time zone offsets from local wall time.