Package org.jooq

Enum JSONFormat.RecordFormat

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ARRAY
      A record is a JSON array.
      OBJECT
      A record is a JSON object.
    • Method Summary

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

      • ARRAY

        public static final JSONFormat.RecordFormat ARRAY
        A record is a JSON array.

        This format allows for accessing columns by index, saving space by avoiding repetitive column names in large result sets. Use this preferrably with JSONFormat.header() equal to true.

      • OBJECT

        public static final JSONFormat.RecordFormat OBJECT
        A record is a JSON object.

        This format allows for accessing columns by name, repeating column names in each record.

    • Method Detail

      • values

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

        public static JSONFormat.RecordFormat 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