Package io.keikai.axyra.sheets.content

Enum Class TimePeriod

java.lang.Object
java.lang.Enum<TimePeriod>
io.keikai.axyra.sheets.content.TimePeriod
All Implemented Interfaces:
Serializable, Comparable<TimePeriod>, Constable
public enum TimePeriod extends Enum<TimePeriod>
The date window of a "date occurring" conditional-formatting rule — ECMA-376 §18.18.82 ST_TimePeriod. Used by ConditionalFormat.Builder.dateOccurring(TimePeriod); "today" is the date when the workbook is calculated, and a cell's time of day is ignored.

  • Enum Constant Details

    • TODAY

      public static final TimePeriod TODAY
      Dates equal to today.

    • YESTERDAY

      public static final TimePeriod YESTERDAY
      Dates equal to today minus one day.

    • TOMORROW

      public static final TimePeriod TOMORROW
      Dates equal to today plus one day.

    • LAST_7_DAYS

      public static final TimePeriod LAST_7_DAYS
      The last seven days, today included.

    • THIS_WEEK

      public static final TimePeriod THIS_WEEK
      The current Sunday-to-Saturday week.

    • LAST_WEEK

      public static final TimePeriod LAST_WEEK
      The previous Sunday-to-Saturday week.

    • NEXT_WEEK

      public static final TimePeriod NEXT_WEEK
      The next Sunday-to-Saturday week.

    • THIS_MONTH

      public static final TimePeriod THIS_MONTH
      The current calendar month.

    • LAST_MONTH

      public static final TimePeriod LAST_MONTH
      The previous calendar month.

    • NEXT_MONTH

      public static final TimePeriod NEXT_MONTH
      The next calendar month.

  • Method Details

    • values

      public static TimePeriod[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TimePeriod valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • token

      public String token()
      The ST_TimePeriod token crossed to the engine.

    • from

      public static TimePeriod from(String token)
      The enum for an ST_TimePeriod token, or null if unknown.