Package ai.preferred.venom.job

Enum Priority

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Priority>
    public enum Priority
extends java.lang.Enum<Priority>
    Job priorities, list in descending order of priority: HIGHEST, HIGH, NORMAL, LOW, LOWEST.
    Author:
    Maksim Tkachenko, Ween Jiann Lee

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      HIGH
      High priority.
      HIGHEST
      Highest priority.
      LOW
      Low priority.
      LOWEST
      Lowest priority.
      NORMAL
      Normal priority.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Priority DEFAULT
      The default starting priority for a job.
      static Priority FLOOR
      The default lowest priority for a job.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Priority downgrade()
      Returns the priority one level below the current priority if priority is higher than the default floor or the lowest available priority.
      Priority downgrade​(Priority floor)
      Returns the priority one level below the current priority if priority is higher than the specified floor or the lowest available priority.
      static Priority valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Priority[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • HIGHEST

        public static final Priority HIGHEST
        Highest priority.

      • HIGH

        public static final Priority HIGH
        High priority.

      • NORMAL

        public static final Priority NORMAL
        Normal priority.

      • LOW

        public static final Priority LOW
        Low priority.

      • LOWEST

        public static final Priority LOWEST
        Lowest priority.

    • Field Detail

      • DEFAULT

        public static final Priority DEFAULT
        The default starting priority for a job.

      • FLOOR

        public static final Priority FLOOR
        The default lowest priority for a job.

    • Method Detail

      • values

        public static Priority[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Priority c : Priority.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Priority valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • downgrade

        public Priority downgrade​(Priority floor)
        Returns the priority one level below the current priority if priority is higher than the specified floor or the lowest available priority. Otherwise return itself.
        Parameters:
        floor - Priority floor
        Returns:
        Priority after downgrade.

      • downgrade

        public Priority downgrade()
        Returns the priority one level below the current priority if priority is higher than the default floor or the lowest available priority. Otherwise return itself.
        Returns:
        Priority after downgrade.