Module io.github.tonywasher.joceanus.oceanus
Package io.github.tonywasher.joceanus.oceanus.date

Enum Class OceanusDatePeriod

java.lang.Object
java.lang.Enum<OceanusDatePeriod>
io.github.tonywasher.joceanus.oceanus.date.OceanusDatePeriod
All Implemented Interfaces:
Serializable, Comparable<OceanusDatePeriod>, Constable
public enum OceanusDatePeriod extends Enum<OceanusDatePeriod>
DatePeriod class representing standard date ranges.
Author:
Tony Washer

  • Enum Constant Details

  • Method Details

    • values

      public static OceanusDatePeriod[] 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 OceanusDatePeriod 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

    • getField

      public ChronoUnit getField()
      Obtain field.
      Returns:
      the field

    • getAmount

      public int getAmount(boolean bForward)
      Obtain amount.
      Parameters:
      bForward - forward/backward amount
      Returns:
      the amount

    • toString

      public String toString()
      Overrides:
      toString in class Enum<OceanusDatePeriod>

    • adjustPeriod

      public boolean adjustPeriod()
      Is period next/previous available?
      Returns:
      true/false

    • datesUpTo

      public boolean datesUpTo()
      Is period DatesUpTo?
      Returns:
      true/false

    • isContaining

      public boolean isContaining()
      Is period a containing period?
      Returns:
      true/false