A JSON formatting type, which can be used to configure JSON imports / exports.

The default format is the following, using header() equal to true and applying RecordFormat#ARRAY:


{"fields":[{"name":"field-1","type":"type-1"},
           {"name":"field-2","type":"type-2"},
            ...,
           {"name":"field-n","type":"type-n"}],
"records":[[value-1-1,value-1-2,...,value-1-n],
           [value-2-1,value-2-2,...,value-2-n]]}

If header() is set to false, then the result is simply the records array, either using RecordFormat#ARRAY:


[[value-1-1,value-1-2,...,value-1-n],
 [value-2-1,value-2-2,...,value-2-n]]

or, using RecordFormat#OBJECT:


[{"field-1": value-1-1, "field-2": value-1-2,..., "field-n": value-1-n},
 {"field-1": value-2-1, "field-2": value-2-2,..., "field-n": value-2-n}]

The type is immutable, meaning calls to setters like header(boolean) do not modify the original reference, but return a new one instead.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	JSONFormat.RecordFormat The format of individual JSON records.

Field Summary

Modifier and Type	Field and Description
public static final JSONFormat	DEFAULT_FOR_RECORDS
public static final JSONFormat	DEFAULT_FOR_RESULTS
pack-priv boolean	format
pack-priv int	globalIndent
pack-priv boolean	header
pack-priv int	indent
pack-priv String[]	indented
pack-priv final boolean	mutable
pack-priv String	newline
pack-priv boolean	quoteNested
pack-priv JSONFormat.RecordFormat	recordFormat
pack-priv boolean	wrapSingleColumnRecords

Constructor Summary

Access	Constructor and Description
public	JSONFormat()
private	JSONFormat(boolean mutable, boolean format, String newline, int globalIndent, int indent, String[] indented, boolean header, JSONFormat.RecordFormat recordFormat, boolean wrapSingleColumnRecords, boolean quoteNested)

Method Summary

Modifier and Type	Method and Description
public final @NotNull JSONFormat	format(boolean newFormat) The new value for the formatting flag, defaulting to `false`.
public final boolean	format() The formatting flag.
public final @NotNull JSONFormat	globalIndent(int newGlobalIndent) The new global indentation size applied on all levels, defaulting to `0`.
public final int	globalIndent() The global indentation applied on all levels.
public final @NotNull JSONFormat	header(boolean newHeader) Whether to emit a header row with column names, defaulting to `true`.
public final boolean	header() Whether to emit a header row with column names, defaulting to `true`.
public final @NotNull JSONFormat	indent(int newIndent) The new indentation size per level value, defaulting to `2`.
public final int	indent() The indentation size per level.
public final @NotNull String	indentString(int level) Convenience method to get an indentation string at a given level.
public final boolean	mutable() Whether this configuration object is mutable.
public final @NotNull JSONFormat	mutable(boolean newMutable) The new value for the mutable flag, defaulting to `false`.
public final @NotNull JSONFormat	newline(String newNewline) The new newline character, defaulting to `\n`.
public final @NotNull String	newline() The formatting flag.
public final @NotNull JSONFormat	quoteNested(boolean newQuoteNested) Whether nested `JSON` or `JSONB` content should be quoted like a string, or nested into JSON formatted output.
public final boolean	quoteNested() Whether nested `JSON` or `JSONB` content should be quoted like a string, or nested into JSON formatted output.
public final @NotNull JSONFormat	recordFormat(JSONFormat.RecordFormat newRecordFormat) The record format to be applied, defaulting to `RecordFormat#ARRAY`.
public final @NotNull JSONFormat.RecordFormat	recordFormat() The record format to be applied, defaulting to `RecordFormat#ARRAY`.
public final @NotNull JSONFormat	wrapSingleColumnRecords(boolean newWrapSingleColumnRecords) Whether to wrap single column records in the `recordFormat()`.
public final boolean	wrapSingleColumnRecords() Whether to wrap single column records in the `recordFormat()`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_FOR_RECORDS	back to summary
public static final JSONFormat DEFAULT_FOR_RECORDS

DEFAULT_FOR_RESULTS	back to summary
public static final JSONFormat DEFAULT_FOR_RESULTS

format	back to summary
pack-priv boolean format

globalIndent	back to summary
pack-priv int globalIndent

header	back to summary
pack-priv boolean header

indent	back to summary
pack-priv int indent

indented	back to summary
pack-priv String[] indented

mutable	back to summary
pack-priv final boolean mutable

newline	back to summary
pack-priv String newline

quoteNested	back to summary
pack-priv boolean quoteNested

recordFormat	back to summary
pack-priv JSONFormat.RecordFormat recordFormat

wrapSingleColumnRecords	back to summary
pack-priv boolean wrapSingleColumnRecords

Constructor Detail

JSONFormat	back to summary
public JSONFormat()

JSONFormat	back to summary
private JSONFormat(boolean mutable, boolean format, String newline, int globalIndent, int indent, String[] indented, boolean header, JSONFormat.RecordFormat recordFormat, boolean wrapSingleColumnRecords, boolean quoteNested)

Method Detail

format back to summary

format	back to summary
public final @NotNull JSONFormat format(boolean newFormat) The new value for the formatting flag, defaulting to `false`. Annotations @NotNull

public final @NotNull JSONFormat format(boolean newFormat)

The new value for the formatting flag, defaulting to false.

Annotations

@NotNull

format	back to summary
public final boolean format() The formatting flag.

globalIndent back to summary

globalIndent	back to summary
public final @NotNull JSONFormat globalIndent(int newGlobalIndent) The new global indentation size applied on all levels, defaulting to `0`. Annotations @NotNull

public final @NotNull JSONFormat globalIndent(int newGlobalIndent)

The new global indentation size applied on all levels, defaulting to 0.

Annotations

@NotNull

globalIndent	back to summary
public final int globalIndent() The global indentation applied on all levels.

header back to summary

header	back to summary
public final @NotNull JSONFormat header(boolean newHeader) Whether to emit a header row with column names, defaulting to `true`. Annotations @NotNull

public final @NotNull JSONFormat header(boolean newHeader)

Whether to emit a header row with column names, defaulting to true.

Annotations

@NotNull

header	back to summary
public final boolean header() Whether to emit a header row with column names, defaulting to `true`.

indent back to summary

indent	back to summary
public final @NotNull JSONFormat indent(int newIndent) The new indentation size per level value, defaulting to `2`. Annotations @NotNull

public final @NotNull JSONFormat indent(int newIndent)

The new indentation size per level value, defaulting to 2.

Annotations

@NotNull

indent	back to summary
public final int indent() The indentation size per level.

indentString	back to summary
public final @NotNull String indentString(int level) Convenience method to get an indentation string at a given level. Annotations @NotNull

indentString

back to summary

public final @NotNull String indentString(int level)

Convenience method to get an indentation string at a given level.

Annotations

@NotNull

mutable	back to summary
public final boolean mutable() Whether this configuration object is mutable.

mutable back to summary

mutable	back to summary
public final @NotNull JSONFormat mutable(boolean newMutable) The new value for the mutable flag, defaulting to `false`. Annotations @NotNull

public final @NotNull JSONFormat mutable(boolean newMutable)

The new value for the mutable flag, defaulting to false.

Annotations

@NotNull

newline back to summary

newline	back to summary
public final @NotNull JSONFormat newline(String newNewline) The new newline character, defaulting to `\n`. Annotations @NotNull

public final @NotNull JSONFormat newline(String newNewline)

The new newline character, defaulting to \n.

Annotations

@NotNull

newline	back to summary
public final @NotNull String newline() The formatting flag. Annotations @NotNull

newline

back to summary

public final @NotNull String newline()

The formatting flag.

Annotations

@NotNull

quoteNested back to summary

quoteNested	back to summary
public final @NotNull JSONFormat quoteNested(boolean newQuoteNested) Whether nested `JSON` or `JSONB` content should be quoted like a string, or nested into JSON formatted output. Annotations @NotNull

public final @NotNull JSONFormat quoteNested(boolean newQuoteNested)

Whether nested JSON or JSONB content should be quoted like a string, or nested into JSON formatted output.

Annotations

@NotNull

quoteNested	back to summary
public final boolean quoteNested() Whether nested `JSON` or `JSONB` content should be quoted like a string, or nested into JSON formatted output.

recordFormat back to summary

recordFormat	back to summary
public final @NotNull JSONFormat recordFormat(JSONFormat.RecordFormat newRecordFormat) The record format to be applied, defaulting to `RecordFormat#ARRAY`. Annotations @NotNull

public final @NotNull JSONFormat recordFormat(JSONFormat.RecordFormat newRecordFormat)

The record format to be applied, defaulting to RecordFormat#ARRAY.

Annotations

@NotNull

recordFormat back to summary

recordFormat	back to summary
public final @NotNull JSONFormat.RecordFormat recordFormat() The record format to be applied, defaulting to `RecordFormat#ARRAY`. Annotations @NotNull

public final @NotNull JSONFormat.RecordFormat recordFormat()

The record format to be applied, defaulting to RecordFormat#ARRAY.

Annotations

@NotNull

wrapSingleColumnRecords back to summary

wrapSingleColumnRecords	back to summary
public final @NotNull JSONFormat wrapSingleColumnRecords(boolean newWrapSingleColumnRecords) Whether to wrap single column records in the `recordFormat()`. Annotations @NotNull

public final @NotNull JSONFormat wrapSingleColumnRecords(boolean newWrapSingleColumnRecords)

Whether to wrap single column records in the recordFormat().

Annotations

@NotNull

wrapSingleColumnRecords	back to summary
public final boolean wrapSingleColumnRecords() Whether to wrap single column records in the `recordFormat()`.

org.jooq back to summary

public final Enum JSONFormat.RecordFormat

Class Inheritance

extends Enum<JSONFormat.RecordFormat>

java.lang.Object
java.lang.Enum
org.jooq.JSONFormat.RecordFormat

The format of individual JSON records.

Field Summary

Modifier and Type	Field and Description
public static final JSONFormat.RecordFormat	ARRAY A record is a JSON array.
public static final JSONFormat.RecordFormat	OBJECT A record is a JSON object.

Constructor Summary

Access	Constructor and Description
private	RecordFormat()

Method Summary

Modifier and Type	Method and Description
public static JSONFormat.RecordFormat	valueOf(String name)
public static JSONFormat.RecordFormat[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ARRAY back to summary

ARRAY	back to summary
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`.

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	back to summary
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.

OBJECT

back to summary

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.

Constructor Detail

RecordFormat	back to summary
private RecordFormat()

Method Detail

valueOf	back to summary
public static JSONFormat.RecordFormat valueOf(String name)

values	back to summary
public static JSONFormat.RecordFormat[] values()

public final Class JSONFormat

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum JSONFormat.RecordFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail