Enum Class BgTime

java.lang.Object
java.lang.Enum<BgTime>
de.spiritscorp.datasync.BgTime
All Implemented Interfaces:
Serializable, Comparable<BgTime>, Constable
public enum BgTime extends Enum<BgTime>
Defines the background execution intervals and their corresponding internal validation check timers for the synchronization tasks.

This enum maps human-readable interval names to explicit millisecond values, allowing the background scheduler to determine when a synchronization run is due and how frequently it should verify the execution state.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DAYLY
    Execution interval set to occur daily.
    HOURLY
    Execution interval set to occur hourly.
    MIN_1
    Execution interval of 1 minute.
    MIN_30
    Execution interval of 30 minutes.
    MIN_5
    Execution interval of 5 minutes.
    MONTHLY
    Execution interval set to occur monthly.
    WEEKLY
    Execution interval set to occur weekly.

  • Method Summary

    Modifier and Type
    Method
    Description
    static BgTime
    get(String str)
    Resolves a matching background time configuration based on its localized display name.
    long
    getCheckTime()
    Gets the specific loop cycle or validation check interval duration.
    String
    getName()
    Gets the localized display name of this interval configuration.
    static String[]
    getNames()
    Extracts and retrieves the localized display names of all available background intervals.
    long
    getTime()
    Gets the total execution interval duration.
    static BgTime
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static BgTime[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • MIN_1

      public static final BgTime MIN_1
      Execution interval of 1 minute.

    • MIN_5

      public static final BgTime MIN_5
      Execution interval of 5 minutes.

    • MIN_30

      public static final BgTime MIN_30
      Execution interval of 30 minutes.

    • HOURLY

      public static final BgTime HOURLY
      Execution interval set to occur hourly.

    • DAYLY

      public static final BgTime DAYLY
      Execution interval set to occur daily.

    • WEEKLY

      public static final BgTime WEEKLY
      Execution interval set to occur weekly.

    • MONTHLY

      public static final BgTime MONTHLY
      Execution interval set to occur monthly.

  • Method Details

    • values

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

    • getNames

      public static String[] getNames()
      Extracts and retrieves the localized display names of all available background intervals.

      This array is typically utilized to populate UI dropdown menus or configuration listings.

      Returns:
      a String array containing the human-readable names in the exact order of definition

    • get

      public static BgTime get(String str)
      Resolves a matching background time configuration based on its localized display name.
      Parameters:
      str - the display name string to look up (e.g., "5 Minuten", "Stündlich")
      Returns:
      the matching BgTime constant, or null if no matching name is found

    • getTime

      public long getTime()
      Gets the total execution interval duration.
      Returns:
      the interval time value represented in milliseconds

    • getName

      public String getName()
      Gets the localized display name of this interval configuration.
      Returns:
      the human-readable interval text

    • getCheckTime

      public long getCheckTime()
      Gets the specific loop cycle or validation check interval duration.
      Returns:
      the check cycle time value represented in milliseconds