Class ISOChronology.Rule

java.lang.Object
javax.time.calendar.CalendricalRule<Integer>
javax.time.calendar.DateTimeFieldRule<Integer>
javax.time.calendar.ISOChronology.Rule
All Implemented Interfaces:
Serializable, Comparable<CalendricalRule<?>>, Comparator<Calendrical>
Enclosing class:
ISOChronology
static final class ISOChronology.Rule extends DateTimeFieldRule<Integer> implements Serializable
Single rule subclass, which means fewer classes to load at startup.

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • ordinal

      private final int ordinal

    • smallestMaximum

      private final transient int smallestMaximum

  • Constructor Details

    • Rule

      private Rule(int ordinal, String name, PeriodUnit periodUnit, PeriodUnit periodRange, int minimumValue, int maximumValue, int smallestMaximum)

  • Method Details

    • readResolve

      private Object readResolve()

    • derive

      protected Integer derive(Calendrical calendrical)
      Description copied from class: CalendricalRule
      Derives the value of this rule from a calendrical.

      This method derives the value for this field from other fields in the calendrical without directly querying the calendrical for the value.

      For example, if this field is quarter-of-year, then the value can be derived from month-of-year.

      The implementation only needs to derive the value based on its immediate parents. The use of Calendrical.get(CalendricalRule) will extract any further parents on demand.

      A typical implementation of this method obtains the parent value and performs a calculation. For example, here is a simple implementation for the quarter-of-year field: 

      Integer moyVal = calendrical.get(ISOChronology.monthOfYearRule());
return (moyVal != null ? ((moyVal - 1) % 4) + 1) : null;

      This method is designed to be overridden in subclasses. The subclass implementation must be thread-safe. The subclass implementation must not request the value of this rule from the specified calendrical, otherwise a stack overflow error will occur.

      Overrides:
      derive in class CalendricalRule<Integer>
      Parameters:
      calendrical - the calendrical to derive from, not null
      Returns:
      the derived value, null if unable to derive

    • getSmallestMaximumValue

      public int getSmallestMaximumValue()
      Description copied from class: DateTimeFieldRule
      Gets the smallest possible maximum value that the field can take.

      The default implementation returns DateTimeFieldRule.getMaximumValue(). Subclasses must override this as necessary.

      Overrides:
      getSmallestMaximumValue in class DateTimeFieldRule<Integer>
      Returns:
      the smallest possible maximum value for this field

    • getMaximumValue

      public int getMaximumValue(Calendrical calendrical)
      Description copied from class: DateTimeFieldRule
      Gets the minimum value that the field can take using the specified calendrical information to refine the accuracy of the response.

      The result of this method will still be inaccurate if there is insufficient information in the calendrical.

      For example, if this field is the ISO day-of-month field, then the number of days in the month varies depending on the month and year. If both the month and year can be derived from the calendrical, then the maximum value returned will be accurate. Otherwise the 'best guess' value from DateTimeFieldRule.getMaximumValue() will be returned.

      The default implementation returns DateTimeFieldRule.getMaximumValue(). Subclasses must override this as necessary.

      Overrides:
      getMaximumValue in class DateTimeFieldRule<Integer>
      Parameters:
      calendrical - context calendrical, not null
      Returns:
      the minimum value of the field given the context

    • compareTo

      public int compareTo(CalendricalRule<?> other)
      Description copied from class: CalendricalRule
      Compares this CalendricalRule to another.

      The comparison is based on the period unit followed by the period range followed by the rule ID. The period unit is compared first, so MinuteOfHour will be less than HourOfDay, which will be less than DayOfWeek. When the period unit is the same, the period range is compared, so DayOfWeek is less than DayOfMonth, which is less than DayOfYear. Finally, the rule ID is compared.

      Specified by:
      compareTo in interface Comparable<CalendricalRule<?>>
      Overrides:
      compareTo in class CalendricalRule<Integer>
      Parameters:
      other - the other type to compare to, not null
      Returns:
      the comparator result, negative if less, positive if greater, zero if equal

    • equals

      public boolean equals(Object obj)
      Description copied from class: CalendricalRule
      Compares two rules based on their ID.
      Specified by:
      equals in interface Comparator<Calendrical>
      Overrides:
      equals in class CalendricalRule<Integer>
      Returns:
      true if the rules are the same

    • hashCode

      public int hashCode()
      Description copied from class: CalendricalRule
      Returns a hash code based on the ID.
      Overrides:
      hashCode in class CalendricalRule<Integer>
      Returns:
      a description of the rule