Package uk.co.sculptor.kflibjava

Enum Class Field.Flag

java.lang.Object
java.lang.Enum<Field.Flag>
uk.co.sculptor.kflibjava.Field.Flag
All Implemented Interfaces:
Serializable, Comparable<Field.Flag>, Constable
Enclosing class:
Field
public static enum Field.Flag extends Enum<Field.Flag>
Field flag enumeration.

  • Enum Constant Details

    • FLDOPT_B

      public static final Field.Flag FLDOPT_B
      Binary get and put

    • FLDOPT_D

      public static final Field.Flag FLDOPT_D
      Assign as day number

    • FLDOPT_E

      public static final Field.Flag FLDOPT_E
      Suppress input echo

    • FLDOPT_F

      public static final Field.Flag FLDOPT_F
      Assign against format

    • FLDOPT_L

      public static final Field.Flag FLDOPT_L
      Fold assigns to lower case

    • FLDOPT_M

      public static final Field.Flag FLDOPT_M
      Assign as Sculptor 2 money

    • FLDOPT_N

      public static final Field.Flag FLDOPT_N
      Assign as numeric

    • FLDOPT_R

      public static final Field.Flag FLDOPT_R
      Remove trailing spaces (get/put)

    • FLDOPT_S

      public static final Field.Flag FLDOPT_S
      Remove leading spaces (print)

    • FLDOPT_T

      public static final Field.Flag FLDOPT_T
      Remove trailing spaces (print)

    • FLDOPT_U

      public static final Field.Flag FLDOPT_U
      Fold assigns to upper case

    • FLDOPT_V

      public static final Field.Flag FLDOPT_V
      Store variable length

    • FLDOPT_C

      public static final Field.Flag FLDOPT_C
      Print centred text (print)

    • FLDOPT_P

      public static final Field.Flag FLDOPT_P
      Alphanumeric packed field (use array as a single field)

    • FLDOPT_USEDINSI

      public static final Field.Flag FLDOPT_USEDINSI
      Used in secondary index (for temporary use in ODBC functions)

    • FLDOPT_MAINKEY

      public static final Field.Flag FLDOPT_MAINKEY
      Main key field

  • Method Details

    • values

      public static Field.Flag[] 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 Field.Flag 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

    • getFromInt

      public static EnumSet<Field.Flag> getFromInt(int scFlags) throws KfException
      Convert a received value to EnumSet<Flag> enumeration set.
      Parameters:
      scFlags - the Sculptor value to be translated to enumeration set.
      Returns:
      the enumeration set
      Throws:
      KfException - when the scFlags value is invalid

    • getScValue

      public static int getScValue(EnumSet<Field.Flag> flags)
      Convert a EnumSet of Field Flags to the Sculptor value used on the server.
      Parameters:
      flags - Database.Flag Enumerator set
      Returns:
      the Sculptor value used on KfServer.

    • getInt

      public int getInt()
      Returns the Field flag as the int value used on KfServer
      Returns:
      Field flag as the int value used on KfServer

    • getFlagFromFormat

      public static EnumSet<Field.Flag> getFlagFromFormat(String format)
      This function is used to return the Field.Flag value extracted from a field format
      Parameters:
      format - a Field format to generate the Flags from
      Returns:
      The corresponding Field.Flags value