Package uk.co.sculptor.kflibjava

Enum Class KeyedFile.Option

java.lang.Object
java.lang.Enum<KeyedFile.Option>
uk.co.sculptor.kflibjava.KeyedFile.Option
All Implemented Interfaces:
Serializable, Comparable<KeyedFile.Option>, Constable
Enclosing class:
KeyedFile
public static enum KeyedFile.Option extends Enum<KeyedFile.Option>
KeyedFile option enumerator.

  • Enum Constant Details

    • INDEX_ONLY

      public static final KeyedFile.Option INDEX_ONLY
      Create an index only file

    • BIGFILE

      public static final KeyedFile.Option BIGFILE
      Create a big file: kfOpenFile()

    • RECREATE

      public static final KeyedFile.Option RECREATE
      Recreate file if it exists

    • KEEPIXOPEN

      public static final KeyedFile.Option KEEPIXOPEN
      Ignore keep index closed flags

    • NOLOG

      public static final KeyedFile.Option NOLOG
      Don't write updates to transaction log

    • USE_SCDATA

      public static final KeyedFile.Option USE_SCDATA
      Use SCDATA/SAGEDATA

    • TEMPFILE

      public static final KeyedFile.Option TEMPFILE
      Temporary file: Delete on close

    • ASC_KEY_INSERTS

      public static final KeyedFile.Option ASC_KEY_INSERTS
      Assume ascending key sequence

    • MIRROR

      public static final KeyedFile.Option MIRROR
      Mirror this file

    • THROW_WARNINGS

      public static final KeyedFile.Option THROW_WARNINGS
      Throw exceptions for warnings (KfLib* client side option)

    • USE_LOCAL_DOT_D

      public static final KeyedFile.Option USE_LOCAL_DOT_D
      The .d file specified represents a local client side file (KfLib* client side option)

  • Method Details

    • values

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

    • getScValue

      public static int getScValue(EnumSet<KeyedFile.Option> options)
      Convert a EnumSet of KeyedFile options to the Sculptor value used on the server.
      Parameters:
      options - KeyedFile.Option Enumerator set
      Returns:
      The Sculptor value used on KfServer.

    • getInt

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