Package com.fauna.codec

Enum FaunaType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FaunaType>
    public enum FaunaType
extends java.lang.Enum<FaunaType>
    Enum representing various FQL data types used by Fauna for data storage and retrieval. These types provide structured representations for encoding and decoding data in FQL queries and responses.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Array
      Represents an array (or list) of values in FQL.
      Boolean
      Represents a boolean value in FQL.
      Bytes
      Represents binary data encoded in Base64 within FQL.
      Date
      Represents a date without time in FQL.
      Document
      Represents a complete document in FQL.
      Double
      Represents a double-precision floating-point number in FQL.
      Int
      Represents an integer value in FQL.
      Long
      Represents a long integer value in FQL.
      Module
      Represents a module in FQL, which serves as a symbolic object with associated methods
      Null
      Represents a null value in FQL, denoting the absence of a value.
      Object
      Represents an object in FQL.
      Ref
      Represents a reference to a document.
      Set
      Represents a pageable Set in FQL.
      Stream
      Represents an event source in FQL.
      String
      Represents a UTF-8 encoded string in FQL.
      Time
      Represents an exact timestamp or time value in FQL.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FaunaType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FaunaType[] 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

      • Int

        public static final FaunaType Int
        Represents an integer value in FQL.

      • Long

        public static final FaunaType Long
        Represents a long integer value in FQL.

      • Double

        public static final FaunaType Double
        Represents a double-precision floating-point number in FQL.

      • String

        public static final FaunaType String
        Represents a UTF-8 encoded string in FQL.

      • Date

        public static final FaunaType Date
        Represents a date without time in FQL. Dates are in ISO 8601 format (YYYY-MM-DD).

      • Time

        public static final FaunaType Time
        Represents an exact timestamp or time value in FQL. Timestamps are in ISO 8601 format.

      • Boolean

        public static final FaunaType Boolean
        Represents a boolean value in FQL.

      • Object

        public static final FaunaType Object
        Represents an object in FQL.

      • Ref

        public static final FaunaType Ref
        Represents a reference to a document.

      • Document

        public static final FaunaType Document
        Represents a complete document in FQL.

      • Array

        public static final FaunaType Array
        Represents an array (or list) of values in FQL. Arrays are ordered collections of elements and can contain multiple data types.

      • Bytes

        public static final FaunaType Bytes
        Represents binary data encoded in Base64 within FQL. Used for storing raw bytes of data.

      • Null

        public static final FaunaType Null
        Represents a null value in FQL, denoting the absence of a value.

      • Stream

        public static final FaunaType Stream
        Represents an event source in FQL. Event sources are used to track events as Event Feeds or Event Streams.

      • Module

        public static final FaunaType Module
        Represents a module in FQL, which serves as a symbolic object with associated methods

      • Set

        public static final FaunaType Set
        Represents a pageable Set in FQL.

    • Method Detail

      • values

        public static FaunaType[] 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 (FaunaType c : FaunaType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FaunaType 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