Package com.fauna.mapping

Enum FieldType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FieldType>
    public enum FieldType
extends java.lang.Enum<FieldType>
    Enum representing the different types of fields that can be used in Fauna document field mappings. Each field type specifies a distinct role or characteristic of a field in the mapping process.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ClientGeneratedId
      Represents a client-generated document ID.
      Coll
      Represents the document's `coll` (collection) metadata field.
      Field
      Represents a user-defined document field.
      ServerGeneratedId
      Represents a Fauna-generated document ID.
      Ts
      Represents the document's `ts` (timestamp) metadata field.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FieldType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FieldType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • ClientGeneratedId

        public static final FieldType ClientGeneratedId
        Represents a client-generated document ID. Typically used when the ID is provided by the client and not generated by Fauna.

      • ServerGeneratedId

        public static final FieldType ServerGeneratedId
        Represents a Fauna-generated document ID. Typically used for document IDs auto-generated by Fauna.

      • Coll

        public static final FieldType Coll
        Represents the document's `coll` (collection) metadata field. Used to denote the collection to which the document belongs.

      • Ts

        public static final FieldType Ts
        Represents the document's `ts` (timestamp) metadata field. Used to track the last write to the document.

      • Field

        public static final FieldType Field
        Represents a user-defined document field.

    • Method Detail

      • values

        public static FieldType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (FieldType c : FieldType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FieldType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null