Package be.gaudry.model.thread

Enum Class EProgressInfo

java.lang.Object
java.lang.Enum<EProgressInfo>
be.gaudry.model.thread.EProgressInfo
All Implemented Interfaces:
Serializable, Comparable<EProgressInfo>, Constable
public enum EProgressInfo extends Enum<EProgressInfo>
Action to perform with the progress event. This enum may be used to set the progress int value with negative values. \n Provided by the broldev.core.model project.
Since:
1.0 Jun 10, 2008, broldev.core.model 0.0.1-SNAPSHOT dependency
Version:
1.0 Jun 10, 2008
Author:
Steph GAUDRY

  • Enum Constant Details

    • PROGRESS

      public static final EProgressInfo PROGRESS
      Normal progress. May get an array of objects

    • CURRENT_INFO

      public static final EProgressInfo CURRENT_INFO
      current file name

    • PROGRESSBARSTYLE_BLOCK

      public static final EProgressInfo PROGRESSBARSTYLE_BLOCK
      adapt the progressBarStyle. May get a string info

    • PROGRESSBARSTYLE_MARQUEE

      public static final EProgressInfo PROGRESSBARSTYLE_MARQUEE
      adapt the progressBarStyle. May get a string info

    • DIR_SIZE

      public static final EProgressInfo DIR_SIZE
      get a Int32 value with count of directories to parse

    • VALUE

      public static final EProgressInfo VALUE
      Argument value of fromInt(int key) method. A numeric value, out of the possible values of this enumeration, may be used to be mapped to a EProgressInfo

    • DONE

      public static final EProgressInfo DONE
      Job done, cancelled, or stopped

    • CURRENT_INFO_IMPORTANT

      public static final EProgressInfo CURRENT_INFO_IMPORTANT

    • ERROR_MSG

      public static final EProgressInfo ERROR_MSG

    • WARNING_MSG

      public static final EProgressInfo WARNING_MSG

    • OK_MSG

      public static final EProgressInfo OK_MSG
      Sub-process with a "true" result, or something opposite to the NEGATIVE_MSG, or operation like create, insert...

    • NEGATIVE_MSG

      public static final EProgressInfo NEGATIVE_MSG
      Sub-process with a "false" result, or something opposite to the OK_MSG, or operation like delete...

    • REMARK

      public static final EProgressInfo REMARK
      Not to be confused with a warning. A remark is a simple piece of information, less important than CURRENT_INFO

  • Method Details

    • values

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

    • getValue

      public int getValue()
      The value is a numeric representation of this EProgressInfo, independent of the Enum.ordinal() information.
      Returns:
      the numeric representation of this

    • getEnclosedUndefinedValue

      public int getEnclosedUndefinedValue()
      Allows to get the real value in case of UNDEFINED state.
      Returns:
      the enclosed value
      Throws:
      UnsupportedOperationException - if called on other state than UNDEFINED

    • toString

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

    • fromInt

      public static EProgressInfo fromInt​(int key)
      Parameters:
      key - numeric representation of the EProgressInfo,value given by the getValue() method.
      Returns:
      the matching EProgressInfo, or VALUE in case of wrong parameter