Package com.apple.foundationdb

Enum Class MutationType

java.lang.Object
java.lang.Enum<MutationType>
com.apple.foundationdb.MutationType
All Implemented Interfaces:
Serializable, Comparable<MutationType>, Constable
public enum MutationType extends Enum<MutationType>
A set of operations that can be performed atomically on a database. These are used as parameters to Transaction.mutate(MutationType, byte[], byte[]).

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADD
    Performs an addition of little-endian integers.
    AND
    Deprecated.
    APPEND_IF_FITS
    Appends param to the end of the existing value already in the database at the given key (or creates the key and sets the value to param if the key is empty).
    BIT_AND
    Performs a bitwise and operation.
    BIT_OR
    Performs a bitwise or operation.
    BIT_XOR
    Performs a bitwise xor operation.
    BYTE_MAX
    Performs lexicographic comparison of byte strings.
    BYTE_MIN
    Performs lexicographic comparison of byte strings.
    COMPARE_AND_CLEAR
    Performs an atomic compare and clear operation.
    MAX
    Performs a little-endian comparison of byte strings.
    MIN
    Performs a little-endian comparison of byte strings.
    OR
    Deprecated.
    SET_VERSIONSTAMPED_KEY
    Transforms key using a versionstamp for the transaction.
    SET_VERSIONSTAMPED_VALUE
    Transforms param using a versionstamp for the transaction.
    XOR
    Deprecated.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    code()
    Gets the FoundationDB native-level constant code for a MutationType.
    static MutationType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MutationType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ADD

      public static final MutationType ADD
      Performs an addition of little-endian integers. If the existing value in the database is not present or shorter than param, it is first extended to the length of param with zero bytes. If param is shorter than the existing value in the database, the existing value is truncated to match the length of param. The integers to be added must be stored in a little-endian representation. They can be signed in two's complement representation or unsigned. You can add to an integer at a known offset in the value by prepending the appropriate number of zero bytes to param and padding with zero bytes to match the length of the value. However, this offset technique requires that you know the addition will not cause the integer field within the value to overflow.

    • AND

      @Deprecated public static final MutationType AND
      Deprecated.
      Deprecated.

    • BIT_AND

      public static final MutationType BIT_AND
      Performs a bitwise and operation. If the existing value in the database is not present, then param is stored in the database. If the existing value in the database is shorter than param, it is first extended to the length of param with zero bytes. If param is shorter than the existing value in the database, the existing value is truncated to match the length of param.

    • OR

      @Deprecated public static final MutationType OR
      Deprecated.
      Deprecated.

    • BIT_OR

      public static final MutationType BIT_OR
      Performs a bitwise or operation. If the existing value in the database is not present or shorter than param, it is first extended to the length of param with zero bytes. If param is shorter than the existing value in the database, the existing value is truncated to match the length of param.

    • XOR

      @Deprecated public static final MutationType XOR
      Deprecated.
      Deprecated.

    • BIT_XOR

      public static final MutationType BIT_XOR
      Performs a bitwise xor operation. If the existing value in the database is not present or shorter than param, it is first extended to the length of param with zero bytes. If param is shorter than the existing value in the database, the existing value is truncated to match the length of param.

    • APPEND_IF_FITS

      public static final MutationType APPEND_IF_FITS
      Appends param to the end of the existing value already in the database at the given key (or creates the key and sets the value to param if the key is empty). This will only append the value if the final concatenated value size is less than or equal to the maximum value size (i.e., if it fits). WARNING: No error is surfaced back to the user if the final value is too large because the mutation will not be applied until after the transaction has been committed. Therefore, it is only safe to use this mutation type if one can guarantee that one will keep the total value size under the maximum size.

    • MAX

      public static final MutationType MAX
      Performs a little-endian comparison of byte strings. If the existing value in the database is not present or shorter than param, it is first extended to the length of param with zero bytes. If param is shorter than the existing value in the database, the existing value is truncated to match the length of param. The larger of the two values is then stored in the database.

    • MIN

      public static final MutationType MIN
      Performs a little-endian comparison of byte strings. If the existing value in the database is not present, then param is stored in the database. If the existing value in the database is shorter than param, it is first extended to the length of param with zero bytes. If param is shorter than the existing value in the database, the existing value is truncated to match the length of param. The smaller of the two values is then stored in the database.

    • SET_VERSIONSTAMPED_KEY

      public static final MutationType SET_VERSIONSTAMPED_KEY
      Transforms key using a versionstamp for the transaction. Sets the transformed key in the database to param. The key is transformed by removing the final four bytes from the key and reading those as a little-Endian 32-bit integer to get a position pos. The 10 bytes of the key from pos to pos + 10 are replaced with the versionstamp of the transaction used. The first byte of the key is position 0. A versionstamp is a 10 byte, unique, monotonically (but not sequentially) increasing value for each committed transaction. The first 8 bytes are the committed version of the database (serialized in big-Endian order). The last 2 bytes are monotonic in the serialization order for transactions. WARNING: At this time, versionstamps are compatible with the Tuple layer only in the Java, Python, and Go bindings. Also, note that prior to API version 520, the offset was computed from only the final two bytes rather than the final four bytes.

    • SET_VERSIONSTAMPED_VALUE

      public static final MutationType SET_VERSIONSTAMPED_VALUE
      Transforms param using a versionstamp for the transaction. Sets the key given to the transformed param. The parameter is transformed by removing the final four bytes from param and reading those as a little-Endian 32-bit integer to get a position pos. The 10 bytes of the parameter from pos to pos + 10 are replaced with the versionstamp of the transaction used. The first byte of the parameter is position 0. A versionstamp is a 10 byte, unique, monotonically (but not sequentially) increasing value for each committed transaction. The first 8 bytes are the committed version of the database (serialized in big-Endian order). The last 2 bytes are monotonic in the serialization order for transactions. WARNING: At this time, versionstamps are compatible with the Tuple layer only in the Java, Python, and Go bindings. Also, note that prior to API version 520, the versionstamp was always placed at the beginning of the parameter rather than computing an offset.

    • BYTE_MIN

      public static final MutationType BYTE_MIN
      Performs lexicographic comparison of byte strings. If the existing value in the database is not present, then param is stored. Otherwise the smaller of the two values is then stored in the database.

    • BYTE_MAX

      public static final MutationType BYTE_MAX
      Performs lexicographic comparison of byte strings. If the existing value in the database is not present, then param is stored. Otherwise the larger of the two values is then stored in the database.

    • COMPARE_AND_CLEAR

      public static final MutationType COMPARE_AND_CLEAR
      Performs an atomic compare and clear operation. If the existing value in the database is equal to the given value, then given key is cleared.

  • Method Details

    • values

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

    • code

      public int code()
      Gets the FoundationDB native-level constant code for a MutationType.
      Returns:
      the native code for a FoundationDB MutationType constant.