org.jooq

Class JSONFormat

java.lang.Object

org.jooq.JSONFormat

public final class JSONFormat
extends Object

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 JSONFormat.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 JSONFormat.RecordFormat.ARRAY:

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

or, using JSONFormat.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}]

Author:

Lukas Eder

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static JSONFormat	DEFAULT_FOR_RECORDS
static JSONFormat	DEFAULT_FOR_RESULTS

Constructor Summary

Constructors

Constructor and Description
JSONFormat()

Method Summary

Modifier and Type	Method and Description
boolean	format() The formatting flag.
JSONFormat	format(boolean newFormat) The new value for the formatting flag, defaulting to false.
boolean	header() Whether to emit a header row with column names, defaulting to true.
JSONFormat	header(boolean newHeader) Whether to emit a header row with column names, defaulting to true.
int	indent() The indentation.
JSONFormat	indent(int newIndent) The new indentation value, defaulting to 2.
String	indentString(int level) Convenience method to get an indentation string at a given level.
String	newline() The formatting flag.
JSONFormat	newline(String newNewline) The new newline character, defaulting to \n.
boolean	quoteNested() Whether nested JSON or JSONB content should be quoted like a string, or nested into JSON formatted output.
JSONFormat	quoteNested(boolean newQuoteNested) Whether nested JSON or JSONB content should be quoted like a string, or nested into JSON formatted output.
JSONFormat.RecordFormat	recordFormat() The record format to be applied, defaulting to JSONFormat.RecordFormat.ARRAY.
JSONFormat	recordFormat(JSONFormat.RecordFormat newRecordFormat) The record format to be applied, defaulting to JSONFormat.RecordFormat.ARRAY.
boolean	wrapSingleColumnRecords() Whether to wrap single column records in the recordFormat().
JSONFormat	wrapSingleColumnRecords(boolean newWrapSingleColumnRecords) Whether to wrap single column records in the recordFormat().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FOR_RESULTS

public static final JSONFormat DEFAULT_FOR_RESULTS

DEFAULT_FOR_RECORDS

public static final JSONFormat DEFAULT_FOR_RECORDS

Constructor Detail

JSONFormat

public JSONFormat()

Method Detail

format

public final JSONFormat format(boolean newFormat)

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

format

public final boolean format()

The formatting flag.

newline

public final JSONFormat newline(String newNewline)

The new newline character, defaulting to \n.

newline

public final String newline()

The formatting flag.

indent

public final JSONFormat indent(int newIndent)

The new indentation value, defaulting to 2.

indent

public final int indent()

The indentation.

indentString

public final String indentString(int level)

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

header

public final JSONFormat header(boolean newHeader)

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

header

public final boolean header()

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

recordFormat

public final JSONFormat recordFormat(JSONFormat.RecordFormat newRecordFormat)

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

recordFormat

public final JSONFormat.RecordFormat recordFormat()

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

wrapSingleColumnRecords

public final JSONFormat wrapSingleColumnRecords(boolean newWrapSingleColumnRecords)

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

wrapSingleColumnRecords

public final boolean wrapSingleColumnRecords()

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

quoteNested

public final JSONFormat quoteNested(boolean newQuoteNested)

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

quoteNested

public final boolean quoteNested()

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