Module org.jooq

Package org.jooq

Interface FormattingProvider

All Known Implementing Classes:

CallbackFormattingProvider, DefaultFormattingProvider

public interface FormattingProvider

An SPI that allows for overriding certain formatting defaults.

For convenience, consider extending DefaultFormattingProvider instead of implementing this interface. This will prevent compilation errors in future versions of jOOQ, when this interface might get new methods.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull ChartFormat	chartFormat()	The ChartFormat to use when calling Formattable.formatChart() and related methods, defaulting to ChartFormat.DEFAULT.
@NotNull CSVFormat	csvFormat()	The CSVFormat to use when calling Formattable.formatCSV() and related methods, defaulting to CSVFormat.DEFAULT.
@NotNull JSONFormat	jsonFormatForRecords()	The JSONFormat to use when calling Formattable.formatJSON() and related methods on records, defaulting to JSONFormat.DEFAULT_FOR_RECORDS.
@NotNull JSONFormat	jsonFormatForResults()	The JSONFormat to use when calling Formattable.formatJSON() and related methods on results, defaulting to JSONFormat.DEFAULT_FOR_RESULTS.
static @NotNull CallbackFormattingProvider	onChartFormat(Supplier<? extends ChartFormat> newOnChartFormat)	Create an FormattingProvider with a chartFormat() implementation.
static @NotNull CallbackFormattingProvider	onCsvFormat(Supplier<? extends CSVFormat> newOnCsvFormat)	Create an FormattingProvider with a csvFormat() implementation.
static @NotNull CallbackFormattingProvider	onJsonFormatForRecords(Supplier<? extends JSONFormat> newOnJsonFormatForRecords)	Create an FormattingProvider with a jsonFormatForRecords() implementation.
static @NotNull CallbackFormattingProvider	onJsonFormatForResults(Supplier<? extends JSONFormat> newOnJsonFormatForResults)	Create an FormattingProvider with a jsonFormatForResults() implementation.
static @NotNull CallbackFormattingProvider	onTxtFormat(Supplier<? extends TXTFormat> newOnTxtFormat)	Create an FormattingProvider with a txtFormat() implementation.
static @NotNull CallbackFormattingProvider	onWidth(ToIntFunction<? super String> newOnWidth)	Create an FormattingProvider with a width(String) implementation.
static @NotNull CallbackFormattingProvider	onXmlFormatForRecords(Supplier<? extends XMLFormat> newOnXmlFormatForRecords)	Create an FormattingProvider with a xmlFormatForRecords() implementation.
static @NotNull CallbackFormattingProvider	onXmlFormatForResults(Supplier<? extends XMLFormat> newOnXmlFormatForResults)	Create an FormattingProvider with a xmlFormatForResults() implementation.
@NotNull TXTFormat	txtFormat()	The TXTFormat to use when calling Formattable.format() and related methods, defaulting to TXTFormat.DEFAULT.
int	width(String string)	The formatting display width in a monospaced font, which may diverge from String.length() e.g.
@NotNull XMLFormat	xmlFormatForRecords()	The XMLFormat to use when calling Formattable.formatXML() and related methods on records, defaulting to XMLFormat.DEFAULT_FOR_RECORDS.
@NotNull XMLFormat	xmlFormatForResults()	The XMLFormat to use when calling Formattable.formatXML() and related methods on results, defaulting to XMLFormat.DEFAULT_FOR_RESULTS.

Method Details

txtFormat

@NotNull
@NotNull TXTFormat txtFormat()

The TXTFormat to use when calling Formattable.format() and related methods, defaulting to TXTFormat.DEFAULT.

csvFormat

@NotNull
@NotNull CSVFormat csvFormat()

The CSVFormat to use when calling Formattable.formatCSV() and related methods, defaulting to CSVFormat.DEFAULT.

jsonFormatForResults

@NotNull
@NotNull JSONFormat jsonFormatForResults()

The JSONFormat to use when calling Formattable.formatJSON() and related methods on results, defaulting to JSONFormat.DEFAULT_FOR_RESULTS.

jsonFormatForRecords

@NotNull
@NotNull JSONFormat jsonFormatForRecords()

The JSONFormat to use when calling Formattable.formatJSON() and related methods on records, defaulting to JSONFormat.DEFAULT_FOR_RECORDS.

xmlFormatForResults

@NotNull
@NotNull XMLFormat xmlFormatForResults()

The XMLFormat to use when calling Formattable.formatXML() and related methods on results, defaulting to XMLFormat.DEFAULT_FOR_RESULTS.

xmlFormatForRecords

@NotNull
@NotNull XMLFormat xmlFormatForRecords()

The XMLFormat to use when calling Formattable.formatXML() and related methods on records, defaulting to XMLFormat.DEFAULT_FOR_RECORDS.

chartFormat

@NotNull
@NotNull ChartFormat chartFormat()

The ChartFormat to use when calling Formattable.formatChart() and related methods, defaulting to ChartFormat.DEFAULT.

width

int width(String string)

The formatting display width in a monospaced font, which may diverge from String.length() e.g. if the string contains a Character.isIdeographic(int) character.

onTxtFormat

@NotNull
static @NotNull CallbackFormattingProvider onTxtFormat(Supplier<? extends TXTFormat> newOnTxtFormat)

Create an FormattingProvider with a txtFormat() implementation.

onCsvFormat

@NotNull
static @NotNull CallbackFormattingProvider onCsvFormat(Supplier<? extends CSVFormat> newOnCsvFormat)

Create an FormattingProvider with a csvFormat() implementation.

onJsonFormatForResults

@NotNull
static @NotNull CallbackFormattingProvider onJsonFormatForResults(Supplier<? extends JSONFormat> newOnJsonFormatForResults)

Create an FormattingProvider with a jsonFormatForResults() implementation.

onJsonFormatForRecords

@NotNull
static @NotNull CallbackFormattingProvider onJsonFormatForRecords(Supplier<? extends JSONFormat> newOnJsonFormatForRecords)

Create an FormattingProvider with a jsonFormatForRecords() implementation.

onXmlFormatForResults

@NotNull
static @NotNull CallbackFormattingProvider onXmlFormatForResults(Supplier<? extends XMLFormat> newOnXmlFormatForResults)

Create an FormattingProvider with a xmlFormatForResults() implementation.

onXmlFormatForRecords

@NotNull
static @NotNull CallbackFormattingProvider onXmlFormatForRecords(Supplier<? extends XMLFormat> newOnXmlFormatForRecords)

Create an FormattingProvider with a xmlFormatForRecords() implementation.

onChartFormat

@NotNull
static @NotNull CallbackFormattingProvider onChartFormat(Supplier<? extends ChartFormat> newOnChartFormat)

Create an FormattingProvider with a chartFormat() implementation.

onWidth

@NotNull
static @NotNull CallbackFormattingProvider onWidth(ToIntFunction<? super String> newOnWidth)

Create an FormattingProvider with a width(String) implementation.