Module org.jooq

Package org.jooq

Enum Class JSONFormat.RecordFormat

java.lang.Object

java.lang.Enum<JSONFormat.RecordFormat>

org.jooq.JSONFormat.RecordFormat

All Implemented Interfaces:

Serializable, Comparable<JSONFormat.RecordFormat>, Constable

Enclosing class:

JSONFormat

public static enum JSONFormat.RecordFormat
extends Enum<JSONFormat.RecordFormat>

The format of individual JSON records.

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
ARRAY	A record is a JSON array.
OBJECT	A record is a JSON object.

Method Summary

Modifier and Type	Method	Description
static JSONFormat.RecordFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JSONFormat.RecordFormat[]	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

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 Details

values

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