Class CallbackFormattingProvider

java.lang.Object

org.jooq.impl.CallbackFormattingProvider

All Implemented Interfaces:

FormattingProvider

public final class CallbackFormattingProvider
extends Object
implements FormattingProvider

A FormattingProvider that allows for functional composition.

For example:

FormattingProvider listener = FormattingProvider
  .on(ctx -> something())
  .onVisitEnd(ctx -> something());

Author:

Lukas Eder

Constructor Summary

Constructors

Constructor	Description
CallbackFormattingProvider()

Method Summary

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

Methods inherited from class Object

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

Constructor Details

CallbackFormattingProvider

public CallbackFormattingProvider()

Method Details

txtFormat

@NotNull
public final @NotNull TXTFormat txtFormat()

Description copied from interface: FormattingProvider

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

Specified by:

txtFormat in interface FormattingProvider

csvFormat

@NotNull
public final @NotNull CSVFormat csvFormat()

Description copied from interface: FormattingProvider

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

Specified by:

csvFormat in interface FormattingProvider

jsonFormatForResults

@NotNull
public final @NotNull JSONFormat jsonFormatForResults()

Description copied from interface: FormattingProvider

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

Specified by:

jsonFormatForResults in interface FormattingProvider

jsonFormatForRecords

@NotNull
public final @NotNull JSONFormat jsonFormatForRecords()

Description copied from interface: FormattingProvider

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

Specified by:

jsonFormatForRecords in interface FormattingProvider

xmlFormatForResults

@NotNull
public final @NotNull XMLFormat xmlFormatForResults()

Description copied from interface: FormattingProvider

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

Specified by:

xmlFormatForResults in interface FormattingProvider

xmlFormatForRecords

@NotNull
public final @NotNull XMLFormat xmlFormatForRecords()

Description copied from interface: FormattingProvider

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

Specified by:

xmlFormatForRecords in interface FormattingProvider

chartFormat

@NotNull
public final @NotNull ChartFormat chartFormat()

Description copied from interface: FormattingProvider

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

Specified by:

chartFormat in interface FormattingProvider

width

public final int width(String string)

Description copied from interface: FormattingProvider

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.

Specified by:

width in interface FormattingProvider

onTxtFormat

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

onCsvFormat

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

onJsonFormatForResults

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

onJsonFormatForRecords

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

onXmlFormatForResults

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

onXmlFormatForRecords

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

onChartFormat

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

onWidth

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