Package uk.co.sculptor.kflibjava

Enum Class KeyedFile.KfStat

java.lang.Object
java.lang.Enum<KeyedFile.KfStat>
uk.co.sculptor.kflibjava.KeyedFile.KfStat
All Implemented Interfaces:
Serializable, Comparable<KeyedFile.KfStat>, Constable
Enclosing class:
KeyedFile
public static enum KeyedFile.KfStat extends Enum<KeyedFile.KfStat>
KeyedFile operation status values.

  • Enum Constant Details

  • Method Details

    • values

      public static KeyedFile.KfStat[] 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 KeyedFile.KfStat 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

    • getFromByte

      public static KeyedFile.KfStat getFromByte(byte kfstat) throws KfException
      Convert a received value to a KfStat enumerator
      Parameters:
      kfstat - The Sculptor value to be translated to enumerator
      Returns:
      The enumerator value
      Throws:
      KfException - When the kfStat value is invalid

    • getByte

      public byte getByte()
      Returns the KeyedFile KfStat as the byte value used on KfServer
      Returns:
      KeyedFile KfStat as the byte value used on KfServer

    • getDescription

      public String getDescription()
      This function is used to return the user description for the Sculptor error.
      Returns:
      The current enumerator description.