Module org.jooq

Package org.jooq.impl

Class CustomRecord<R extends TableRecord<R>>

java.lang.Object

org.jooq.impl.TableRecordImpl<R>

org.jooq.impl.CustomRecord<R>

All Implemented Interfaces:

Serializable, Comparable<Record>, SQLData, Attachable, Fields, Formattable, QualifiedRecord<R>, Record, TableRecord<R>

public abstract class CustomRecord<R extends TableRecord<R>>
extends TableRecordImpl<R>

A base class for custom TableRecord implementations in client code.

Client code may provide proper TableRecord implementations extending this useful base class. All necessary parts of the TableRecord interface are already implemented. No methods need further implementation, but implementations have to provide a no-arg constructor that can be called reflectively.

Use this base class when providing custom tables to any of the following methods:

• ResultQuery.fetchInto(Table)
• Cursor.fetchInto(Table)
• Result.into(Table)
• Record.into(Table)

Author:

Lukas Eder

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomRecord(Table<R> table)

Method Summary

Modifier and Type	Method	Description
final void	attach(Configuration c)	Attach this object to a new Configuration.
final boolean	changed()	Deprecated.
final void	changed(boolean c)	Deprecated.
final boolean	changed(int fieldIndex)	Deprecated.
final void	changed(int fieldIndex, boolean c)	Deprecated.
final boolean	changed(String fieldName)	Deprecated.
final void	changed(String fieldName, boolean c)	Deprecated.
final boolean	changed(Field<?> field)	Deprecated.
final void	changed(Field<?> field, boolean c)	Deprecated.
final boolean	changed(Name fieldName)	Deprecated.
final void	changed(Name fieldName, boolean c)	Deprecated.
int	compareTo(Record that)	Compares this Record with another Record according to their natural ordering.
final Configuration	configuration()	Get the currently attached Configuration, or null if no Configuration is attached.
protected final DSLContext	create()	Deprecated. - 3.11.0 - [#6720] [#6721] - Use Attachable.configuration() and Configuration.dsl() instead.
default DataType<?>	dataType(int index)	Get the field data type for a given field index, or null if no field is available at the index.
default DataType<?>	dataType(String name)	Get the field data type for a given qualified field name, or null if no field is known to this type by this name.
default DataType<?>	dataType(Name name)	Get the field data type for a given qualified field name, or null if no field is known to this type by this name.
default DataType<?>[]	dataTypes()	Get an array of field data types for this type.
final void	detach()	Detach this object from its current Configuration.
boolean	equals(Object obj)
default Field<?>	field(int index)	Get a field known to this type by index, or null if no field is available at the index.
default <T> Field<T>	field(int index, Class<T> type)	Get a field known to this type by index coerced to type using Field.coerce(Class), or null if no field is available at the index.
default <T> Field<T>	field(int index, DataType<T> dataType)	Get a field known to this type by index coerced to dataType using Field.coerce(DataType), or null if no field is available at the index.
default Field<?>	field(String name)	Deprecated. This method hides static import DSL.field(String).
default <T> Field<T>	field(String name, Class<T> type)	Deprecated. This method hides static import DSL.field(String, Class).
default <T> Field<T>	field(String name, DataType<T> dataType)	Deprecated. This method hides static import DSL.field(String, DataType).
default <T> Field<T>	field(Field<T> field)	Get a field known to this type by field reference.
default Field<?>	field(Name name)	Deprecated. This method hides static import DSL.field(Name).
default <T> Field<T>	field(Name name, Class<T> type)	Deprecated. This method hides static import DSL.field(Name, Class).
default <T> Field<T>	field(Name name, DataType<T> dataType)	Deprecated. This method hides static import DSL.field(String, DataType).
default Field<?>[]	fields()	Get all fields known to this type.
default Field<?>[]	fields(int... indexes)	Get all fields known to this type, filtering by some field indexes.
default Field<?>[]	fields(String... names)	Get all fields known to this type, filtering by some unqualified field names.
default Field<?>[]	fields(Field<?>... fields)	Get all fields, filtering by some fields.
default Field<?>[]	fields(Name... names)	Get all fields known to this type, filtering by some qualified field names.
default Fields	fieldsIncludingHidden()	Get another Fields instance that includes the hidden fields.
Row	fieldsRow()	Get all fields known to this type as a Row.
default Stream<Field<?>>	fieldStream()	Get all fields known to this type as a Stream.
final String	format()	Get a simple formatted representation of this result.
final String	format(int maxRecords)	Get a simple formatted representation of this result.
final void	format(OutputStream stream)	Like Formattable.format(), but the data is output onto an OutputStream.
final void	format(OutputStream stream, int maxRecords)	Like Formattable.format(int), but the data is output onto an OutputStream.
final void	format(OutputStream stream, TXTFormat format)	Like Formattable.format(TXTFormat), but the data is output onto an OutputStream.
final void	format(Writer writer)	Like Formattable.format(), but the data is output onto a Writer.
final void	format(Writer writer, int maxRecords)	Like Formattable.format(int), but the data is output onto a Writer.
final void	format(Writer writer, TXTFormat format)	Like Formattable.format(TXTFormat), but the data is output onto a Writer.
final String	format(TXTFormat format)	Get a simple formatted representation of this result.
final String	formatChart()	Get this result as an ASCII chart.
final void	formatChart(OutputStream stream)	Like Formattable.formatChart(), but the data is output onto an OutputStream.
final void	formatChart(OutputStream stream, ChartFormat format)	Like Formattable.formatChart(ChartFormat), but the data is output onto an OutputStream.
final void	formatChart(Writer writer)	Like Formattable.formatChart(), but the data is output onto a Writer.
final void	formatChart(Writer writer, ChartFormat format)	Like Formattable.formatChart(ChartFormat), but the data is output onto a Writer.
final String	formatChart(ChartFormat format)	Get this result as an ASCII chart.
final String	formatCSV()	Get a simple formatted representation of this result as CSV.
final String	formatCSV(boolean header)	Get a simple formatted representation of this result as CSV.
final String	formatCSV(boolean header, char delimiter)	Get a simple formatted representation of this result as CSV.
final String	formatCSV(boolean header, char delimiter, String nullString)	Get a simple formatted representation of this result as CSV.
final String	formatCSV(char delimiter)	Get a simple formatted representation of this result as CSV.
final String	formatCSV(char delimiter, String nullString)	Get a simple formatted representation of this result as CSV.
final void	formatCSV(OutputStream stream)	Like Formattable.formatCSV(), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, boolean header)	Like Formattable.formatCSV(boolean), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, boolean header, char delimiter)	Like Formattable.formatCSV(boolean, char), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, boolean header, char delimiter, String nullString)	Like Formattable.formatCSV(boolean, char, String), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, char delimiter)	Like Formattable.formatCSV(char), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, char delimiter, String nullString)	Like Formattable.formatCSV(char, String), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, CSVFormat format)	Like Formattable.formatCSV(CSVFormat), but the data is output onto an OutputStream.
final void	formatCSV(Writer writer)	Like Formattable.formatCSV(), but the data is output onto a Writer.
final void	formatCSV(Writer writer, boolean header)	Like Formattable.formatCSV(boolean), but the data is output onto a Writer.
final void	formatCSV(Writer writer, boolean header, char delimiter)	Like Formattable.formatCSV(boolean, char), but the data is output onto a Writer.
final void	formatCSV(Writer writer, boolean header, char delimiter, String nullString)	Like Formattable.formatCSV(boolean, char, String), but the data is output onto a Writer.
final void	formatCSV(Writer writer, char delimiter)	Like Formattable.formatCSV(char), but the data is output onto a Writer.
final void	formatCSV(Writer writer, char delimiter, String nullString)	Like Formattable.formatCSV(char, String), but the data is output onto a Writer.
final void	formatCSV(Writer writer, CSVFormat format)	Like Formattable.formatCSV(CSVFormat), but the data is output onto a Writer.
final String	formatCSV(CSVFormat format)	Get a simple formatted representation of this result as CSV.
final String	formatHTML()	Get a simple formatted representation of this result as HTML.
final void	formatHTML(OutputStream stream)	Like Formattable.formatHTML(), but the data is output onto an OutputStream.
final void	formatHTML(Writer writer)	Like Formattable.formatHTML(), but the data is output onto a Writer.
final String	formatInsert()	Get this result as a set of INSERT statements.
final void	formatInsert(OutputStream stream)	Like Formattable.formatInsert(), but the data is output onto an OutputStream.
final void	formatInsert(OutputStream stream, Table<?> table, Field<?>... f)	Like Formattable.formatInsert(Table, Field...), but the data is output onto an OutputStream.
final void	formatInsert(Writer writer)	Like Formattable.formatInsert(), but the data is output onto a Writer.
final void	formatInsert(Writer writer, Table<?> table, Field<?>... f)	Like Formattable.formatInsert(Table, Field...), but the data is output onto an Writer.
final String	formatInsert(Table<?> table, Field<?>... f)	Get this result as a set of INSERT statements.
final String	formatJSON()	Get a simple formatted representation of this result as a JSON array of array.
final void	formatJSON(OutputStream stream)	Like Formattable.formatJSON(), but the data is output onto an OutputStream.
final void	formatJSON(OutputStream stream, JSONFormat format)	Like Formattable.formatJSON(JSONFormat), but the data is output onto an OutputStream.
final void	formatJSON(Writer writer)	Like Formattable.formatJSON(), but the data is output onto a Writer.
final void	formatJSON(Writer writer, JSONFormat format)	Like Formattable.formatJSON(JSONFormat), but the data is output onto a Writer.
final String	formatJSON(JSONFormat format)	Get a simple formatted representation of this result as a JSON data structure, according to the format.
final String	formatXML()	Get this result formatted as XML.
final void	formatXML(OutputStream stream)	Like Formattable.formatXML(), but the data is output onto an OutputStream.
final void	formatXML(OutputStream stream, XMLFormat format)	Like Formattable.formatXML(XMLFormat), but the data is output onto an OutputStream.
final void	formatXML(Writer writer)	Like Formattable.formatXML(), but the data is output onto a Writer.
final void	formatXML(Writer writer, XMLFormat format)	Like Formattable.formatXML(XMLFormat), but the data is output onto a Writer.
final String	formatXML(XMLFormat format)	Get this result formatted as XML.
final void	from(Object source)	Load data into this record from a source.
final void	from(Object source, int... fieldIndexes)	Load data into this record from a source, providing some field indexes.
final void	from(Object source, String... fieldNames)	Load data into this record from a source, providing some field names, using Fields.field(String) for lookup.
final void	from(Object source, Field<?>... f)	Load data into this record from a source, providing some fields, using Fields.field(Field) for lookup.
final void	from(Object source, Name... fieldNames)	Load data into this record from a source, providing some field names, using Fields.field(Name) for lookup.
protected final void	from(Record source)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.20.0 - [#16815] - Do not reuse this method.
final void	fromArray(Object... array)	Load data from an array into this record.
final void	fromArray(Object[] array, int... fieldIndexes)	Load data from an array into this record, providing some fields indexes.
final void	fromArray(Object[] array, String... fieldNames)	Load data from an array into this record, providing some fields names, using Fields.field(String) for lookup.
final void	fromArray(Object[] array, Field<?>... f)	Load data from an array into this record, providing some fields, using Fields.field(Field) for lookup.
final void	fromArray(Object[] array, Name... fieldNames)	Load data from an array into this record, providing some fields names, using Fields.field(Name) for lookup.
final void	fromMap(Map<String,?> map)	Load data from a map into this record, using Fields.field(String) for lookup.
final void	fromMap(Map<String,?> map, int... fieldIndexes)	Load data from a map into this record, providing some field indexes.
final void	fromMap(Map<String,?> map, String... fieldNames)	Load data from a map into this record, providing some field names, using Fields.field(String) for lookup.
final void	fromMap(Map<String,?> map, Field<?>... f)	Load data from a map into this record, providing some fields, using Fields.field(Field) for lookup.
final void	fromMap(Map<String,?> map, Name... fieldNames)	Load data from a map into this record, providing some field names, using Fields.field(Name) for lookup.
final Object	get(int index)	Get a value from this record, providing a field index.
final <U> U	get(int index, Class<? extends U> type)	Get a converted value from this record, providing a field index.
final <U> U	get(int index, Converter<?,? extends U> converter)	Get a converted value from this record, providing a field index.
final Object	get(String fieldName)	Get a value from this Record, providing a field name, using Fields.field(String) for lookup.
final <T> T	get(String fieldName, Class<? extends T> type)	Get a converted value from this Record, providing a field name, using Fields.field(String) for lookup.
final <U> U	get(String fieldName, Converter<?,? extends U> converter)	Get a converted value from this Record, providing a field name, using Fields.field(String) for lookup.
final <U> U	get(Field<?> field, Class<? extends U> type)	Get a converted value from this Record, providing a field, using Fields.field(Field) for lookup.
final <T> T	get(Field<T> field)	Get a value from this Record, providing a field, using Fields.field(Field) for lookup.
final <T, U> U	get(Field<T> field, Converter<? super T,? extends U> converter)	Get a converted value from this Record, providing a field, using Fields.field(Field) for lookup.
final Object	get(Name fieldName)	Get a value from this Record, providing a field name, using Fields.field(Name) for lookup.
final <T> T	get(Name fieldName, Class<? extends T> type)	Get a converted value from this Record, providing a field name, using Fields.field(Name) for lookup.
final <U> U	get(Name fieldName, Converter<?,? extends U> converter)	Get a converted value from this Record, providing a field name, using Fields.field(Name) for lookup.
final RecordQualifier<R>	getQualifier()	Get the UDT or Table reference.
final String	getSQLTypeName()
final Object	getValue(int index)	Get a value from this record, providing a field index.
final <T> T	getValue(int index, Class<? extends T> type)	Get a converted value from this record, providing a field index.
final <U> U	getValue(int index, Converter<?,? extends U> converter)	Get a converted value from this record, providing a field index.
final Object	getValue(String fieldName)	Get a value from this Record, providing a field name, using Fields.field(String) for lookup.
final <T> T	getValue(String fieldName, Class<? extends T> type)	Get a converted value from this Record, providing a field name, using Fields.field(String) for lookup.
final <U> U	getValue(String fieldName, Converter<?,? extends U> converter)	Get a converted value from this Record, providing a field name, using Fields.field(String) for lookup.
final <T> T	getValue(Field<?> field, Class<? extends T> type)	Get a converted value from this Record, providing a field, using Fields.field(Field) for lookup.
final <T> T	getValue(Field<T> field)	Get a value from this Record, providing a field, using Fields.field(Field) for lookup.
final <T, U> U	getValue(Field<T> field, Converter<? super T,? extends U> converter)	Get a converted value from this Record, providing a field, using Fields.field(Field) for lookup.
final Object	getValue(Name fieldName)	Get a value from this Record, providing a field name, using Fields.field(Name) for lookup.
final <T> T	getValue(Name fieldName, Class<? extends T> type)	Get a converted value from this Record, providing a field name, using Fields.field(Name) for lookup.
final <U> U	getValue(Name fieldName, Converter<?,? extends U> converter)	Get a converted value from this Record, providing a field name, using Fields.field(Name) for lookup.
int	hashCode()
default int	indexOf(String name)	Get a field's index from this type.
default int	indexOf(Field<?> field)	Get a field's index from this type.
default int	indexOf(Name name)	Get a field's index from this type.
final Fields	internalFieldsRow()
<E> E	into(E object)	Map resulting records onto a custom type.
final <E> E	into(Class<? extends E> type)	Map resulting records onto a custom type.
final Record	into(Field<?>... f)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1> Record1<T1>	into(Field<T1> field1)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2> Record2<T1,T2>	into(Field<T1> field1, Field<T2> field2)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3> Record3<T1,T2,T3>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4> Record4<T1,T2,T3,T4>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5> Record5<T1,T2,T3,T4,T5>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6> Record6<T1,T2,T3,T4,T5,T6>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7> Record7<T1,T2,T3,T4,T5,T6,T7>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8> Record8<T1,T2,T3,T4,T5,T6,T7,T8>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9> Record9<T1,T2,T3,T4,T5,T6,T7,T8,T9>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> Record10<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> Record11<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> Record12<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> Record13<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> Record14<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> Record15<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> Record16<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17> Record17<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18> Record18<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19> Record19<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18, Field<T19> field19)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20> Record20<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18, Field<T19> field19, Field<T20> field20)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21> Record21<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18, Field<T19> field19, Field<T20> field20, Field<T21> field21)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22> Record22<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21,T22>	into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18, Field<T19> field19, Field<T20> field20, Field<T21> field21, Field<T22> field22)	Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.
final <R extends Record> R	into(Table<R> table)	Map resulting records onto a custom record type.
final Object[]	intoArray()	Convert this record into an array.
final List<Object>	intoList()	Convert this record into a list.
final Map<String,Object>	intoMap()	Return this record as a name/value map.
final ResultSet	intoResultSet()	Generate an in-memory JDBC ResultSet containing the data of this Record.
final Stream<Object>	intoStream()	Convert this record into a stream.
final Document	intoXML()	Get this result as XML.
final <H extends ContentHandler> H	intoXML(H handler)	Get this result as XML using a SAX ContentHandler.
final <H extends ContentHandler> H	intoXML(H handler, XMLFormat format)	Get this result as XML using a SAX ContentHandler.
final Document	intoXML(XMLFormat format)	Get this result as XML.
final <E> E	map(RecordMapper<Record,E> mapper)	Map this record into a custom mapper callback.
final boolean	modified()	Check if this record has been modified since it was created or fetched from the database.
final boolean	modified(int fieldIndex)	Check if a field's value has been modified since the record was created or fetched from the database, using Fields.field(int) for lookup.
final boolean	modified(String fieldName)	Check if a field's value has been modified since the record was created or fetched from the database, using Fields.field(String) for lookup.
final boolean	modified(Field<?> field)	Check if a field's value has been modified since the record was created or fetched from the database, using Fields.field(Field) for lookup.
final boolean	modified(Name fieldName)	Check if a field's value has been modified since the record was created or fetched from the database, using Fields.field(Name) for lookup.
final Object	original(int fieldIndex)	Get an original value from this record as fetched from the database.
final Object	original(String fieldName)	Get an original value from this record as fetched from the database, using Fields.field(String) for lookup.
final <T> T	original(Field<T> field)	Get an original value from this record as fetched from the database, using Fields.field(Field) for lookup.
final Object	original(Name fieldName)	Get an original value from this record as fetched from the database, using Fields.field(Name) for lookup.
final void	readSQL(SQLInput stream, String typeName)
final void	reset()	Reset all values to their Record.original() values and all Record.touched() flags to false.
final void	reset(int fieldIndex)	Reset a given value to its Record.original(int) value and its Record.touched(int) flag to false.
final void	reset(String fieldName)	Reset a given value to its Record.original(String) value and its Record.touched(String) flag to false, using Fields.field(String) for lookup.
final void	reset(Field<?> field)	Reset a given value to its Record.original(Field) value and its Record.touched(Field) flag to false, using Fields.field(Field) for lookup.
final void	reset(Name fieldName)	Reset a given value to its Record.original(Name) value and its Record.touched(Name) flag to false, using Fields.field(Name) for lookup.
protected void	resetChangedOnNotNull()	Deprecated. - [#12494] - 3.20.0 - Please re-generate your code
protected void	resetTouchedOnNotNull()	Generated subclasses may call this method.
protected final void	set(int index, Object value)
final <T> void	set(Field<T> field, T value)	Set a value into this record, using Fields.field(Field) for lookup.
final <T, U> void	set(Field<T> field, U value, Converter<? extends T,? super U> converter)	Set a value into this record, using Fields.field(Field) for lookup.
protected final void	setValue(int index, Object value)	Deprecated. - Use AbstractRecord.set(int, Object) instead
final <T> void	setValue(Field<T> field, T value)	Set a value into this record, using Fields.field(Field) for lookup.
final <T, U> void	setValue(Field<T> field, U value, Converter<? extends T,? super U> converter)	Set a value into this record, using Fields.field(Field) for lookup.
final int	size()	Get the number of fields of this record.
String	toString()
final boolean	touched()	Check if this record has been touched since it was created or fetched from the database.
final void	touched(boolean c)	Set all of this record's internal touched flags to the supplied value.
final boolean	touched(int fieldIndex)	Check if a field's value has been touched since the record was created or fetched from the database, using Fields.field(int) for lookup.
final void	touched(int fieldIndex, boolean c)	Set this record's internal touched flag to the supplied value for a given field.
final boolean	touched(String fieldName)	Check if a field's value has been touched since the record was created or fetched from the database, using Fields.field(String) for lookup.
final void	touched(String fieldName, boolean c)	Set this record's internal touched flag to the supplied value for a given field, using Fields.field(String) for lookup.
final boolean	touched(Field<?> field)	Check if a field's value has been touched since the record was created or fetched from the database, using Fields.field(Field) for lookup.
final void	touched(Field<?> field, boolean c)	Set this record's internal touched flag to the supplied value for a given field, using Fields.field(Field) for lookup.
final boolean	touched(Name fieldName)	Check if a field's value has been touched since the record was created or fetched from the database, using Fields.field(Name) for lookup.
final void	touched(Name fieldName, boolean c)	Set this record's internal touched flag to the supplied value for a given field, using Fields.field(Name) for lookup.
default Class<?>	type(int index)	Get the field type for a given field index, or null if no field is available at the index.
default Class<?>	type(String name)	Get the field type for a given unqualified field name, or null if no field is known to this type by this name.
default Class<?>	type(Name name)	Get the field type for a given qualified field name, or null if no field is known to this type by this name.
default Class<?>[]	types()	Get an array of field types for fields known to this type.
Row	valuesRow()	Get this record's values as a Row.
final void	writeSQL(SQLOutput stream)

Methods inherited from class org.jooq.impl.TableRecordImpl

fetchParent, getTable, insert, insert, insert, original, parent, with, with

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jooq.Attachable

attach, configuration, detach

Methods inherited from interface org.jooq.Fields

fieldsRow

Methods inherited from interface org.jooq.Formattable

format, format, format, format, format, format, format, format, format, formatChart, formatChart, formatChart, formatChart, formatChart, formatChart, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatHTML, formatHTML, formatHTML, formatInsert, formatInsert, formatInsert, formatInsert, formatInsert, formatInsert, formatJSON, formatJSON, formatJSON, formatJSON, formatJSON, formatJSON, formatXML, formatXML, formatXML, formatXML, formatXML, formatXML, intoXML, intoXML, intoXML, intoXML

Methods inherited from interface org.jooq.QualifiedRecord

getQualifier

Methods inherited from interface org.jooq.Record

changed, changed, changed, changed, changed, changed, changed, changed, changed, changed, compareTo, equals, from, from, from, from, from, fromArray, fromArray, fromArray, fromArray, fromArray, fromMap, fromMap, fromMap, fromMap, fromMap, get, get, get, get, get, get, get, get, get, get, get, get, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, hashCode, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, intoArray, intoList, intoMap, intoResultSet, intoStream, map, modified, modified, modified, modified, modified, original, original, original, original, reset, reset, reset, reset, reset, set, set, setValue, setValue, size, touched, touched, touched, touched, touched, touched, touched, touched, touched, touched, valuesRow

Methods inherited from interface java.sql.SQLData

getSQLTypeName, readSQL, writeSQL

Constructor Details

CustomRecord

protected CustomRecord(Table<R> table)

Method Details

getQualifier

public final RecordQualifier<R> getQualifier()

Description copied from interface: QualifiedRecord

Get the UDT or Table reference.

Specified by:

getQualifier in interface QualifiedRecord<R extends QualifiedRecord<R>>

fieldsRow

public Row fieldsRow()

Description copied from interface: Fields

Get all fields known to this type as a Row.

Specified by:

fieldsRow in interface Fields

valuesRow

public Row valuesRow()

Description copied from interface: Record

Get this record's values as a Row.

Specified by:

valuesRow in interface Record

getSQLTypeName

public final String getSQLTypeName()
                            throws SQLException

Specified by:

getSQLTypeName in interface SQLData

Throws:

SQLException

readSQL

public final void readSQL(SQLInput stream,
 String typeName)
                   throws SQLException

Specified by:

readSQL in interface SQLData

Throws:

SQLException

writeSQL

public final void writeSQL(SQLOutput stream)
                    throws SQLException

Specified by:

writeSQL in interface SQLData

Throws:

SQLException

internalFieldsRow

@Internal
public final Fields internalFieldsRow()

size

public final int size()

Description copied from interface: Record

Get the number of fields of this record.

Specified by:

size in interface Record

get

public final <T> T get(Field<T> field)

Description copied from interface: Record

Get a value from this Record, providing a field, using Fields.field(Field) for lookup.

If this record contains a field with the same Field.getName() as the argument field, that value is retrieved.

Specified by:

get in interface Record

Type Parameters:

T - The generic field parameter

Parameters:

field - The field

Returns:

The value of a field contained in this record

get

public final <U> U get(Field<?> field,
 Class<? extends U> type)

Description copied from interface: Record

Get a converted value from this Record, providing a field, using Fields.field(Field) for lookup.

The Converter that is provided by Configuration.converterProvider() will be used to convert the value to U

If this record contains a field with the same Field.getName() as the argument field, that value is retrieved.

Specified by:

get in interface Record

Type Parameters:

U - The conversion type parameter

Parameters:

field - The field

type - The conversion type

Returns:

The value of a field contained in this record

get

public final <T,
U> U get(Field<T> field,
 Converter<? super T,? extends U> converter)

Description copied from interface: Record

Get a converted value from this Record, providing a field, using Fields.field(Field) for lookup.

If this record contains a field with the same Field.getName() as the argument field, that value is retrieved.

Specified by:

get in interface Record

Type Parameters:

T - The database type parameter

U - The conversion type parameter

Parameters:

field - The field

converter - The data type converter

Returns:

The value of a field contained in this record

get

public final Object get(int index)

Description copied from interface: Record

Get a value from this record, providing a field index.

Specified by:

get in interface Record

Parameters:

index - The 0-based field index in this record.

Returns:

The value of a field's index contained in this record

get

public final <U> U get(int index,
 Class<? extends U> type)

Description copied from interface: Record

Get a converted value from this record, providing a field index.

The Converter that is provided by Configuration.converterProvider() will be used to convert the value to U

Specified by:

get in interface Record

Type Parameters:

U - The conversion type parameter

Parameters:

index - The 0-based field index in this record.

type - The conversion type

Returns:

The value of a field's index contained in this record

get

public final <U> U get(int index,
 Converter<?,? extends U> converter)

Description copied from interface: Record

Get a converted value from this record, providing a field index.

Specified by:

get in interface Record

Type Parameters:

U - The conversion type parameter

Parameters:

index - The 0-based field index in this record.

converter - The data type converter

Returns:

The value of a field's index contained in this record

get

public final Object get(String fieldName)

Description copied from interface: Record

Get a value from this Record, providing a field name, using Fields.field(String) for lookup.

Specified by:

get in interface Record

Parameters:

fieldName - The field's name

Returns:

The value of a field's name contained in this record

get

public final <T> T get(String fieldName,
 Class<? extends T> type)

Description copied from interface: Record

Get a converted value from this Record, providing a field name, using Fields.field(String) for lookup.

The Converter that is provided by Configuration.converterProvider() will be used to convert the value to U

Specified by:

get in interface Record

Type Parameters:

T - The conversion type parameter

Parameters:

fieldName - The field's name

type - The conversion type

Returns:

The value of a field's name contained in this record

get

public final <U> U get(String fieldName,
 Converter<?,? extends U> converter)

Description copied from interface: Record

Get a converted value from this Record, providing a field name, using Fields.field(String) for lookup.

Specified by:

get in interface Record

Type Parameters:

U - The conversion type parameter

Parameters:

fieldName - The field's name

converter - The data type converter

Returns:

The value of a field's name contained in this record

get

public final Object get(Name fieldName)

Description copied from interface: Record

Get a value from this Record, providing a field name, using Fields.field(Name) for lookup.

Specified by:

get in interface Record

Parameters:

fieldName - The field's name

Returns:

The value of a field's name contained in this record

get

public final <T> T get(Name fieldName,
 Class<? extends T> type)

Description copied from interface: Record

Get a converted value from this Record, providing a field name, using Fields.field(Name) for lookup.

The Converter that is provided by Configuration.converterProvider() will be used to convert the value to U

Specified by:

get in interface Record

Type Parameters:

T - The conversion type parameter

Parameters:

fieldName - The field's name

type - The conversion type

Returns:

The value of a field's name contained in this record

get

public final <U> U get(Name fieldName,
 Converter<?,? extends U> converter)

Description copied from interface: Record

Get a converted value from this Record, providing a field name, using Fields.field(Name) for lookup.

Specified by:

get in interface Record

Type Parameters:

U - The conversion type parameter

Parameters:

fieldName - The field's name

converter - The data type converter

Returns:

The value of a field's name contained in this record

setValue

@Deprecated
protected final void setValue(int index,
 Object value)

Deprecated.

- Use AbstractRecord.set(int, Object) instead

Subclasses may type-unsafely set a value to a record index. This method takes care of converting the value to the appropriate type.

set

protected final void set(int index,
 Object value)

set

public final <T> void set(Field<T> field,
 T value)

Description copied from interface: Record

Set a value into this record, using Fields.field(Field) for lookup.

This will always set the Record.touched(Field) flag for the given field, no matter if setting the value actually changes the value.

Changing Table.getPrimaryKey() values will set all Record.touched() flags to true, in order to produce complete INSERT statements on subsequent UpdatableRecord.store() operations.

Specified by:

set in interface Record

Type Parameters:

T - The generic field parameter

Parameters:

field - The field

value - The value

set

public final <T,
U> void set(Field<T> field,
 U value,
 Converter<? extends T,? super U> converter)

Description copied from interface: Record

Set a value into this record, using Fields.field(Field) for lookup.

This will always set the Record.touched(Field) flag for the given field, no matter if setting the value actually changes the value.

Changing Table.getPrimaryKey() values will set all Record.touched() flags to true, in order to produce complete INSERT statements on subsequent UpdatableRecord.store() operations.

Specified by:

set in interface Record

Type Parameters:

T - The generic field parameter

U - The conversion type parameter

Parameters:

field - The field

value - The value

converter - The converter used to convert value into an appropriate type

original

public final <T> T original(Field<T> field)

Description copied from interface: Record

Get an original value from this record as fetched from the database, using Fields.field(Field) for lookup.

Record values can be freely modified after having fetched a record from the database. Every record also references the originally fetched values. This method returns such an original value for a field.

Specified by:

original in interface Record

See Also:

• Record.original()

original

public final Object original(int fieldIndex)

Description copied from interface: Record

Get an original value from this record as fetched from the database.

Record values can be freely modified after having fetched a record from the database. Every record also references the originally fetched values. This method returns such an original value for a field.

Specified by:

original in interface Record

Parameters:

fieldIndex - The 0-based field index in this record.

See Also:

• Record.original()

original

public final Object original(String fieldName)

Description copied from interface: Record

Get an original value from this record as fetched from the database, using Fields.field(String) for lookup.

Record values can be freely modified after having fetched a record from the database. Every record also references the originally fetched values. This method returns such an original value for a field.

Specified by:

original in interface Record

See Also:

• Record.original()

original

public final Object original(Name fieldName)

Description copied from interface: Record

Get an original value from this record as fetched from the database, using Fields.field(Name) for lookup.

Record values can be freely modified after having fetched a record from the database. Every record also references the originally fetched values. This method returns such an original value for a field.

Specified by:

original in interface Record

See Also:

• Record.original()

changed

@Deprecated
public final boolean changed()

Deprecated.

Description copied from interface: Record

Check if this record has been changed from its original as fetched from the database.

If this returns false, then it can be said that record.equals(record.original()) is true.

Specified by:

changed in interface Record

See Also:

• Record.original()
• Record.changed(Field)
• Record.changed(int)
• Record.changed(String)

changed

@Deprecated
public final boolean changed(Field<?> field)

Deprecated.

Description copied from interface: Record

Check if a field's value has been changed from its original as fetched from the database, using Fields.field(Field) for lookup.

Specified by:

changed in interface Record

See Also:

• Record.changed()
• Record.original(Field)

changed

@Deprecated
public final boolean changed(int fieldIndex)

Deprecated.

Description copied from interface: Record

Check if a field's value has been changed from its original as fetched from the database.

Specified by:

changed in interface Record

Parameters:

fieldIndex - The 0-based field index in this record.

See Also:

• Record.changed()
• Record.original(int)

changed

@Deprecated
public final boolean changed(String fieldName)

Deprecated.

Description copied from interface: Record

Check if a field's value has been changed from its original as fetched from the database, using Fields.field(String) for lookup.

Specified by:

changed in interface Record

See Also:

• Record.changed()
• Record.original(String)

changed

@Deprecated
public final boolean changed(Name fieldName)

Deprecated.

Description copied from interface: Record

Check if a field's value has been changed from its original as fetched from the database, using Fields.field(Name) for lookup.

Specified by:

changed in interface Record

See Also:

• Record.changed()
• Record.original(Name)

changed

@Deprecated
public final void changed(boolean c)

Deprecated.

Description copied from interface: Record

Set all of this record's internal changed flags to the supplied value.

If the changed argument is false, the Record.original() values will be reset to the corresponding "current" values as well

Specified by:

changed in interface Record

See Also:

• Record.changed()
• Record.changed(Field, boolean)
• Record.changed(int, boolean)
• Record.changed(String, boolean)

changed

@Deprecated
public final void changed(Field<?> field,
 boolean c)

Deprecated.

Description copied from interface: Record

Set this record's internal changed flag to the supplied value for a given field, using Fields.field(Field) for lookup.

If the changed argument is false, the Record.original(Field) value will be reset to the corresponding "current" value as well

Specified by:

changed in interface Record

See Also:

• Record.changed()
• Record.changed(Field)

changed

@Deprecated
public final void changed(int fieldIndex,
 boolean c)

Deprecated.

Description copied from interface: Record

Set this record's internal changed flag to the supplied value for a given field.

If the changed argument is false, the Record.original(int) value will be reset to the corresponding "current" value as well

Specified by:

changed in interface Record

Parameters:

fieldIndex - The 0-based field index in this record.

See Also:

• Record.changed()
• Record.changed(int)

changed

@Deprecated
public final void changed(String fieldName,
 boolean c)

Deprecated.

Description copied from interface: Record

Set this record's internal changed flag to the supplied value for a given field, using Fields.field(String) for lookup.

If the changed argument is false, the Record.original(String) value will be reset to the corresponding "current" value as well

Specified by:

changed in interface Record

See Also:

• Record.changed()
• Record.changed(String)

changed

@Deprecated
public final void changed(Name fieldName,
 boolean c)

Deprecated.

Description copied from interface: Record

Set this record's internal changed flag to the supplied value for a given field, using Fields.field(Name) for lookup.

If the changed argument is false, the Record.original(Name) value will be reset to the corresponding "current" value as well

Specified by:

changed in interface Record

See Also:

• Record.changed()
• Record.changed(Name)

touched

public final boolean touched()

Description copied from interface: Record

Check if this record has been touched since it was created or fetched from the database.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

See Also:

• Record.original()
• Record.touched(Field)
• Record.touched(int)
• Record.touched(String)

touched

public final boolean touched(Field<?> field)

Description copied from interface: Record

Check if a field's value has been touched since the record was created or fetched from the database, using Fields.field(Field) for lookup.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

See Also:

• Record.touched()
• Record.original(Field)

touched

public final boolean touched(int fieldIndex)

Description copied from interface: Record

Check if a field's value has been touched since the record was created or fetched from the database, using Fields.field(int) for lookup.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

Parameters:

fieldIndex - The 0-based field index in this record.

See Also:

• Record.touched()
• Record.original(int)

touched

public final boolean touched(String fieldName)

Description copied from interface: Record

Check if a field's value has been touched since the record was created or fetched from the database, using Fields.field(String) for lookup.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

See Also:

• Record.touched()
• Record.original(String)

touched

public final boolean touched(Name fieldName)

Description copied from interface: Record

Check if a field's value has been touched since the record was created or fetched from the database, using Fields.field(Name) for lookup.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

See Also:

• Record.touched()
• Record.original(Name)

touched

public final void touched(boolean c)

Description copied from interface: Record

Set all of this record's internal touched flags to the supplied value.

If the touched argument is false, the Record.original() values will be reset to the corresponding "current" values as well.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

See Also:

• Record.touched()
• Record.touched(Field, boolean)
• Record.touched(int, boolean)
• Record.touched(String, boolean)

touched

public final void touched(Field<?> field,
 boolean c)

Description copied from interface: Record

Set this record's internal touched flag to the supplied value for a given field, using Fields.field(Field) for lookup.

If the touched argument is false, the Record.original(Field) value will be reset to the corresponding "current" value as well.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

See Also:

• Record.touched()
• Record.touched(Field)

touched

public final void touched(int fieldIndex,
 boolean c)

Description copied from interface: Record

Set this record's internal touched flag to the supplied value for a given field.

If the touched argument is false, the Record.original(int) value will be reset to the corresponding "current" value as well.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

Parameters:

fieldIndex - The 0-based field index in this record.

See Also:

• Record.touched()
• Record.touched(int)

touched

public final void touched(String fieldName,
 boolean c)

Description copied from interface: Record

Set this record's internal touched flag to the supplied value for a given field, using Fields.field(String) for lookup.

If the touched argument is false, the Record.touched(String) value will be reset to the corresponding "current" value as well.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

See Also:

• Record.touched()
• Record.touched(String)

touched

public final void touched(Name fieldName,
 boolean c)

Description copied from interface: Record

Set this record's internal touched flag to the supplied value for a given field, using Fields.field(Name) for lookup.

If the touched argument is false, the Record.original(Name) value will be reset to the corresponding "current" value as well.

A record may have been Record.touched() (a setter was called) without having been Record.modified() (a value was changed).

Specified by:

touched in interface Record

See Also:

• Record.touched()
• Record.touched(Name)

modified

public final boolean modified()

Description copied from interface: Record

Check if this record has been modified since it was created or fetched from the database.

When a record is Record.modified(), then it has always been Record.touched() as well. Unlike the Record.touched() property, this property cannot be set and is derived only from the comparison between this record and the Record.original() record.

Specified by:

modified in interface Record

See Also:

• Record.original()
• Record.modified(Field)
• Record.modified(int)
• Record.modified(String)

modified

public final boolean modified(Field<?> field)

Description copied from interface: Record

Check if a field's value has been modified since the record was created or fetched from the database, using Fields.field(Field) for lookup.

When a record is Record.modified(), then it has always been Record.touched() as well. Unlike the Record.touched(Field) property, this property cannot be set and is derived only from the comparison between #get(Field) and Record.original(Field) values.

Specified by:

modified in interface Record

See Also:

• Record.modified()
• Record.original(Field)

modified

public final boolean modified(int fieldIndex)

Description copied from interface: Record

Check if a field's value has been modified since the record was created or fetched from the database, using Fields.field(int) for lookup.

When a record is Record.modified(), then it has always been Record.touched() as well. Unlike the Record.touched(int) property, this property cannot be set and is derived only from the comparison between #get(int) and Record.original(int) values.

Specified by:

modified in interface Record

Parameters:

fieldIndex - The 0-based field index in this record.

See Also:

• Record.modified()
• Record.original(int)

modified

public final boolean modified(String fieldName)

Description copied from interface: Record

Check if a field's value has been modified since the record was created or fetched from the database, using Fields.field(String) for lookup.

When a record is Record.modified(), then it has always been Record.touched() as well. Unlike the Record.touched(String) property, this property cannot be set and is derived only from the comparison between #get(String) and Record.original(String) values.

Specified by:

modified in interface Record

See Also:

• Record.modified()
• Record.original(String)

modified

public final boolean modified(Name fieldName)

Description copied from interface: Record

Check if a field's value has been modified since the record was created or fetched from the database, using Fields.field(Name) for lookup.

When a record is Record.modified(), then it has always been Record.touched() as well. Unlike the Record.touched(Name) property, this property cannot be set and is derived only from the comparison between #get(Name) and Record.original(Name) values.

Specified by:

modified in interface Record

See Also:

• Record.modified()
• Record.original(Name)

reset

public final void reset()

Description copied from interface: Record

Reset all values to their Record.original() values and all Record.touched() flags to false.

Specified by:

reset in interface Record

reset

public final void reset(Field<?> field)

Description copied from interface: Record

Reset a given value to its Record.original(Field) value and its Record.touched(Field) flag to false, using Fields.field(Field) for lookup.

Specified by:

reset in interface Record

reset

public final void reset(int fieldIndex)

Description copied from interface: Record

Reset a given value to its Record.original(int) value and its Record.touched(int) flag to false.

Specified by:

reset in interface Record

Parameters:

fieldIndex - The 0-based field index in this record.

reset

public final void reset(String fieldName)

Description copied from interface: Record

Reset a given value to its Record.original(String) value and its Record.touched(String) flag to false, using Fields.field(String) for lookup.

Specified by:

reset in interface Record

reset

public final void reset(Name fieldName)

Description copied from interface: Record

Reset a given value to its Record.original(Name) value and its Record.touched(Name) flag to false, using Fields.field(Name) for lookup.

Specified by:

reset in interface Record

intoArray

public final Object[] intoArray()

Description copied from interface: Record

Convert this record into an array.

The resulting array has the same number of elements as this record has fields. The resulting array contains data as such:

 
 // For arbitrary values of i
 record.getValue(i) == record.intoArray()[i]
 
 

This is the same as calling into(Object[].class)

Specified by:

intoArray in interface Record

Returns:

This record as an array

See Also:

• Record.fromArray(Object...)

intoList

public final List<Object> intoList()

Description copied from interface: Record

Convert this record into a list.

The resulting list has the same number of elements as this record has fields. The resulting array contains data as such:

 
 // For arbitrary values of i
 record.getValue(i) == record.intoList().get(i)
 
 

This is the same as calling Arrays.asList(intoArray())

Specified by:

intoList in interface Record

intoStream

public final Stream<Object> intoStream()

Description copied from interface: Record

Convert this record into a stream.

The resulting stream has the same number of elements as this record has fields. The resulting stream contains data as such:

This is the same as calling into(Stream.class)

Specified by:

intoStream in interface Record

Returns:

This record as a stream

intoMap

public final Map<String,Object> intoMap()

Description copied from interface: Record

Return this record as a name/value map.

This is the inverse operation to Record.fromMap(Map)

Specified by:

intoMap in interface Record

Returns:

This record as a map

See Also:

• Record.fromMap(Map)

into

public final Record into(Field<?>... f)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Parameters:

f - The fields of the new record

Returns:

The new record

into

public final <T1> Record1<T1> into(Field<T1> field1)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2> Record2<T1,T2> into(Field<T1> field1,
 Field<T2> field2)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3> Record3<T1,T2,T3> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4> Record4<T1,T2,T3,T4> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5>
Record5<T1,T2,T3,T4,T5> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6>
Record6<T1,T2,T3,T4,T5,T6> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7>
Record7<T1,T2,T3,T4,T5,T6,T7> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8>
Record8<T1,T2,T3,T4,T5,T6,T7,T8> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9>
Record9<T1,T2,T3,T4,T5,T6,T7,T8,T9> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10>
Record10<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11>
Record11<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12>
Record12<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13>
Record13<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14>
Record14<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14,
T15>
Record15<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14,
 Field<T15> field15)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14,
T15,
T16>
Record16<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14,
 Field<T15> field15,
 Field<T16> field16)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14,
T15,
T16,
T17>
Record17<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14,
 Field<T15> field15,
 Field<T16> field16,
 Field<T17> field17)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14,
T15,
T16,
T17,
T18>
Record18<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14,
 Field<T15> field15,
 Field<T16> field16,
 Field<T17> field17,
 Field<T18> field18)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14,
T15,
T16,
T17,
T18,
T19>
Record19<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14,
 Field<T15> field15,
 Field<T16> field16,
 Field<T17> field17,
 Field<T18> field18,
 Field<T19> field19)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14,
T15,
T16,
T17,
T18,
T19,
T20>
Record20<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14,
 Field<T15> field15,
 Field<T16> field16,
 Field<T17> field17,
 Field<T18> field18,
 Field<T19> field19,
 Field<T20> field20)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14,
T15,
T16,
T17,
T18,
T19,
T20,
T21>
Record21<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14,
 Field<T15> field15,
 Field<T16> field16,
 Field<T17> field17,
 Field<T18> field18,
 Field<T19> field19,
 Field<T20> field20,
 Field<T21> field21)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <T1,
T2,
T3,
T4,
T5,
T6,
T7,
T8,
T9,
T10,
T11,
T12,
T13,
T14,
T15,
T16,
T17,
T18,
T19,
T20,
T21,
T22>
Record22<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21,T22> into(Field<T1> field1,
 Field<T2> field2,
 Field<T3> field3,
 Field<T4> field4,
 Field<T5> field5,
 Field<T6> field6,
 Field<T7> field7,
 Field<T8> field8,
 Field<T9> field9,
 Field<T10> field10,
 Field<T11> field11,
 Field<T12> field12,
 Field<T13> field13,
 Field<T14> field14,
 Field<T15> field15,
 Field<T16> field16,
 Field<T17> field17,
 Field<T18> field18,
 Field<T19> field19,
 Field<T20> field20,
 Field<T21> field21,
 Field<T22> field22)

Description copied from interface: Record

Copy this record into a new record holding only a subset of the previous fields, using Fields.field(Field) for lookup.

Specified by:

into in interface Record

Returns:

The new record

See Also:

• Record.into(Table)

into

public final <E> E into(Class<? extends E> type)

Description copied from interface: Record

Map resulting records onto a custom type.

This will map this record onto your custom type using a RecordMapper as provided by Configuration.recordMapperProvider(). If no custom provider is specified, the DefaultRecordMapperProvider is used.

Specified by:

into in interface Record

Type Parameters:

E - The generic entity type.

Parameters:

type - The entity type.

See Also:

• Record.from(Object)
• DefaultRecordMapper

into

public <E> E into(E object)

Description copied from interface: Record

Map resulting records onto a custom type.

This is the same as Record.into(Class), except that no new object is instantiated as a result. Instead, you can provide your own custom POJO, array, record, etc. instance.

Specified by:

into in interface Record

Type Parameters:

E - The generic entity type.

Parameters:

object - The receiving POJO, array, record, etc.

See Also:

• Record.from(Object)

into

public final <R extends Record> R into(Table<R> table)

Description copied from interface: Record

Map resulting records onto a custom record type.

The mapping algorithm is this:

jOOQ will map Record values by equal field names:

• For every field in the table argument with Field.getName() "MY_field" (case-sensitive!), a corresponding field with the same name in this record will be searched.
• If several fields in this record share the same Field.getName(), then the first one returning true on Field.equals(Object) will be returned. (e.g. qualified field names match)

Other restrictions

• RecordQualifier.getRecordType() must return a class of type TableRecord, which must provide a default constructor. Non-public default constructors are made accessible using Constructor.setAccessible(boolean)

Specified by:

into in interface Record

Type Parameters:

R - The generic table record type.

Parameters:

table - The table type.

intoResultSet

public final ResultSet intoResultSet()

Description copied from interface: Record

Generate an in-memory JDBC ResultSet containing the data of this Record.

Use this as an adapter for JDBC-compliant code that expects a ResultSet to operate on, rather than a jOOQ Result. The returned ResultSet allows for the following behaviour according to the JDBC specification:

• ResultSet.CLOSE_CURSORS_AT_COMMIT: The cursors (i.e. Statement object) are no longer available
• ResultSet.CONCUR_READ_ONLY: You cannot update the database through this ResultSet, as the underlying Result object does not hold any open database refences anymore
• ResultSet.FETCH_FORWARD: The fetch direction is forward only, and cannot be changed
• ResultSet.TYPE_SCROLL_INSENSITIVE: You can use any of the ResultSet's scrolling methods, e.g. ResultSet.next() or ResultSet.previous(), etc.

You may use DSLContext.fetch(ResultSet) to unwind this wrapper again.

This is the same as creating a new Result with this Record only, and then calling Result.intoResultSet() on that Result

Specified by:

intoResultSet in interface Record

Returns:

A wrapper JDBC ResultSet

map

public final <E> E map(RecordMapper<Record,E> mapper)

Description copied from interface: Record

Map this record into a custom mapper callback.

Specified by:

map in interface Record

Parameters:

mapper - The mapper callback

Returns:

The custom mapped record

resetChangedOnNotNull

@Deprecated
protected void resetChangedOnNotNull()

Deprecated.

- [#12494] - 3.20.0 - Please re-generate your code

Generated subclasses may call this method.

resetTouchedOnNotNull

protected void resetTouchedOnNotNull()

Generated subclasses may call this method.

from

public final void from(Object source)

Description copied from interface: Record

Load data into this record from a source.

The mapping algorithm is this:

If source is an array

Loading of data is delegated to Record.fromArray(Object...)

If source is a Map

Loading of data is delegated to Record.fromMap(Map)

If source is an Iterable

Loading of data is equivalent to loading Record.fromArray(Object...), transforming the Iterable to an array, first.

If any JPA

invalid reference

jakarta.persistence.Column

annotations are found on the Class of the provided source, only those are used (assuming the jOOQ-jpa-extensions module is on the classpath and Configuration.annotatedPojoMemberProvider() configures it. Matching candidates are:

• Public no-argument instance methods annotated with jakarta.persistence.Column
• Public no-argument instance methods starting with getXXX or isXXX, if there exists a matching public single-argument setXXX() instance method that is annotated with jakarta.persistence.Column
• Public instance member fields annotated with jakarta.persistence.Column

Additional matching rules:

• invalid reference

  jakarta.persistence.Column#name()

  must match Field.getName(). All other annotation attributes are ignored
• Only the first match per field is used
• Matching methods have a higher priority than matching member fields
• Explicitly matching methods have a higher priority than implicitly matching methods (implicitly matching getter = setter is annotated)
• Static methods / member fields are ignored

If there are no JPA jakarta.persistence.Column annotations, or jOOQ can't find the jakarta.persistence API on the classpath, jOOQ will map members by naming convention:

If Field.getName() is MY_field (case-sensitive!), then this field's value will be fetched from the first of these:

• Public no-argument instance method MY_field()
• Public no-argument instance method myField()
• Public no-argument instance method getMY_field()
• Public no-argument instance method getMyField()
• Public instance member field MY_field
• Public instance member field myField

Other restrictions

• primitive types are supported.

General notes

The resulting record will have its internal "touched" flags set to true for all values. This means that UpdatableRecord.store() will perform an INSERT statement. If you wish to store the record using an UPDATE statement, use DSLContext.executeUpdate(UpdatableRecord) instead.

This is the same as calling record.from(source, record.fields())

Specified by:

from in interface Record

Parameters:

source - The source object to copy data from

See Also:

• Record.into(Class)
• Record.from(Object, Field...)

from

public final void from(Object source,
 Field<?>... f)

Description copied from interface: Record

Load data into this record from a source, providing some fields, using Fields.field(Field) for lookup.

This is the same as Record.from(Object), except that only fields contained in the fields argument will be mapped.

Specified by:

from in interface Record

Parameters:

source - The source object to copy data from

f - The record's fields to use for mapping

See Also:

• Record.into(Class)
• Record.from(Object)

from

public final void from(Object source,
 String... fieldNames)

Description copied from interface: Record

Load data into this record from a source, providing some field names, using Fields.field(String) for lookup.

This is the same as Record.from(Object), except that only fields contained in the fieldNames argument will be mapped.

Specified by:

from in interface Record

Parameters:

source - The source object to copy data from

fieldNames - The record's fields names to use for mapping

See Also:

• Record.into(Class)
• Record.from(Object)

from

public final void from(Object source,
 Name... fieldNames)

Description copied from interface: Record

Load data into this record from a source, providing some field names, using Fields.field(Name) for lookup.

This is the same as Record.from(Object), except that only fields contained in the fieldNames argument will be mapped.

Specified by:

from in interface Record

Parameters:

source - The source object to copy data from

fieldNames - The record's fields names to use for mapping

See Also:

• Record.into(Class)
• Record.from(Object)

from

public final void from(Object source,
 int... fieldIndexes)

Description copied from interface: Record

Load data into this record from a source, providing some field indexes.

This is the same as Record.from(Object), except that only fields contained in the fieldIndexes argument will be mapped.

Specified by:

from in interface Record

Parameters:

source - The source object to copy data from

fieldIndexes - The record's 0-based field indexes to use for mapping

See Also:

• Record.into(Class)
• Record.from(Object)

fromMap

public final void fromMap(Map<String,?> map)

Description copied from interface: Record

Load data from a map into this record, using Fields.field(String) for lookup.

The argument map is expected to hold field-name / value pairs where field-names correspond to actual field names as provided by Fields.field(String). Missing fields will be left untouched. Excess fields will be ignored.

This is the inverse operation to Record.intoMap(). This is the same as calling record.fromMap(map, record.fields())

Specified by:

fromMap in interface Record

See Also:

• Record.intoMap()
• Record.fromMap(Map, Field...)

fromMap

public final void fromMap(Map<String,?> map,
 Field<?>... f)

Description copied from interface: Record

Load data from a map into this record, providing some fields, using Fields.field(Field) for lookup.

The argument map is expected to hold field-name / value pairs where field-names correspond to actual field names as provided by Fields.field(String). Missing fields will be left untouched. Excess fields will be ignored.

This is the same as Record.fromMap(Map), except that only fields contained in the fields argument will be mapped.

Specified by:

fromMap in interface Record

See Also:

• Record.intoMap()
• Record.fromMap(Map)

fromMap

public final void fromMap(Map<String,?> map,
 String... fieldNames)

Description copied from interface: Record

Load data from a map into this record, providing some field names, using Fields.field(String) for lookup.

The argument map is expected to hold field-name / value pairs where field-names correspond to actual field names as provided by Fields.field(String). Missing fields will be left untouched. Excess fields will be ignored.

This is the same as Record.fromMap(Map), except that only fields contained in the fieldNames argument will be mapped.

Specified by:

fromMap in interface Record

See Also:

• Record.intoMap()
• Record.fromMap(Map)

fromMap

public final void fromMap(Map<String,?> map,
 Name... fieldNames)

Description copied from interface: Record

Load data from a map into this record, providing some field names, using Fields.field(Name) for lookup.

The argument map is expected to hold field-name / value pairs where field-names correspond to actual field names as provided by Fields.field(Name). Missing fields will be left untouched. Excess fields will be ignored.

This is the same as Record.fromMap(Map), except that only fields contained in the fieldNames argument will be mapped.

Specified by:

fromMap in interface Record

See Also:

• Record.intoMap()
• Record.fromMap(Map)

fromMap

public final void fromMap(Map<String,?> map,
 int... fieldIndexes)

Description copied from interface: Record

Load data from a map into this record, providing some field indexes.

The argument map is expected to hold field-name / value pairs where field-names correspond to actual field names as provided by Fields.field(String). Missing fields will be left untouched. Excess fields will be ignored.

This is the same as Record.fromMap(Map), except that only fields contained in the fieldIndexes argument will be mapped.

Specified by:

fromMap in interface Record

Parameters:

fieldIndexes - The 0-based field indexes in this record.

See Also:

• Record.intoMap()
• Record.fromMap(Map)

fromArray

public final void fromArray(Object... array)

Description copied from interface: Record

Load data from an array into this record.

The argument array is expected to hold values for this record's field indexes. Missing values will be left untouched. Excess values will be ignored.

This is the inverse operation to Record.intoArray()

Specified by:

fromArray in interface Record

See Also:

• Record.intoArray()
• Record.fromArray(Object[], Field...)

fromArray

public final void fromArray(Object[] array,
 Field<?>... f)

Description copied from interface: Record

Load data from an array into this record, providing some fields, using Fields.field(Field) for lookup.

The argument array is expected to hold values for this record's field indexes. Missing values will be left untouched. Excess values will be ignored.

This is the same as Record.fromArray(Object...), except that only fields contained in the fields argument will be mapped.

Specified by:

fromArray in interface Record

See Also:

• Record.intoArray()
• Record.fromArray(Object...)

fromArray

public final void fromArray(Object[] array,
 String... fieldNames)

Description copied from interface: Record

Load data from an array into this record, providing some fields names, using Fields.field(String) for lookup.

The argument array is expected to hold values for this record's field indexes. Missing values will be left untouched. Excess values will be ignored.

This is the same as Record.fromArray(Object...), except that only fields contained in the fieldNames argument will be mapped.

Specified by:

fromArray in interface Record

See Also:

• Record.intoArray()
• Record.fromArray(Object...)

fromArray

public final void fromArray(Object[] array,
 Name... fieldNames)

Description copied from interface: Record

Load data from an array into this record, providing some fields names, using Fields.field(Name) for lookup.

The argument array is expected to hold values for this record's field indexes. Missing values will be left untouched. Excess values will be ignored.

This is the same as Record.fromArray(Object...), except that only fields contained in the fieldNames argument will be mapped.

Specified by:

fromArray in interface Record

See Also:

• Record.intoArray()
• Record.fromArray(Object...)

fromArray

public final void fromArray(Object[] array,
 int... fieldIndexes)

Description copied from interface: Record

Load data from an array into this record, providing some fields indexes.

The argument array is expected to hold values for this record's field indexes. Missing values will be left untouched. Excess values will be ignored.

This is the same as Record.fromArray(Object...), except that only fields contained in the fieldIndexes argument will be mapped.

Specified by:

fromArray in interface Record

Parameters:

fieldIndexes - The 0-based field indexes in this record.

See Also:

• Record.intoArray()
• Record.fromArray(Object...)

from

@Deprecated(forRemoval=true)
protected final void from(Record source)

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.20.0 - [#16815] - Do not reuse this method.

format

public final void format(Writer writer,
 TXTFormat format)

Description copied from interface: Formattable

Like Formattable.format(TXTFormat), but the data is output onto a Writer.

Specified by:

format in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 CSVFormat format)

Description copied from interface: Formattable

Like Formattable.formatCSV(CSVFormat), but the data is output onto a Writer.

Specified by:

formatCSV in interface Formattable

formatJSON

public final void formatJSON(Writer writer,
 JSONFormat format)

Description copied from interface: Formattable

Like Formattable.formatJSON(JSONFormat), but the data is output onto a Writer.

Specified by:

formatJSON in interface Formattable

formatXML

public final void formatXML(Writer writer,
 XMLFormat format)

Description copied from interface: Formattable

Like Formattable.formatXML(XMLFormat), but the data is output onto a Writer.

Specified by:

formatXML in interface Formattable

formatHTML

public final void formatHTML(Writer writer)

Description copied from interface: Formattable

Like Formattable.formatHTML(), but the data is output onto a Writer.

Specified by:

formatHTML in interface Formattable

formatChart

public final void formatChart(Writer writer,
 ChartFormat format)

Description copied from interface: Formattable

Like Formattable.formatChart(ChartFormat), but the data is output onto a Writer.

Specified by:

formatChart in interface Formattable

formatInsert

public final void formatInsert(Writer writer)

Description copied from interface: Formattable

Like Formattable.formatInsert(), but the data is output onto a Writer.

Specified by:

formatInsert in interface Formattable

formatInsert

public final void formatInsert(Writer writer,
 Table<?> table,
 Field<?>... f)

Description copied from interface: Formattable

Like Formattable.formatInsert(Table, Field...), but the data is output onto an Writer.

Specified by:

formatInsert in interface Formattable

intoXML

public final Document intoXML(XMLFormat format)

Description copied from interface: Formattable

Get this result as XML.

Specified by:

intoXML in interface Formattable

See Also:

• Formattable.formatXML()
• http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

intoXML

public final <H extends ContentHandler> H intoXML(H handler,
 XMLFormat format)
                                           throws SAXException

Description copied from interface: Formattable

Get this result as XML using a SAX ContentHandler.

Specified by:

intoXML in interface Formattable

Parameters:

handler - The custom content handler.

Returns:

The argument content handler is returned for convenience.

Throws:

SAXException

See Also:

• Formattable.formatXML()
• http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Record that)

Description copied from interface: Record

Compares this Record with another Record according to their natural ordering.

jOOQ Records implement Comparable to allow for naturally ordering Records in a "SQL way", i.e. according to the following rules:

Records being compared must have the same ROW type

Two Records are comparable if and only if they have the same ROW type, i.e. if their fieldsRow() methods return fields of the same type and degree.

Comparison rules

Assume the following notations:

• X[i] means X.getValue(i)
• X = Y means X.compareTo(Y) == 0
• X < Y means X.compareTo(Y) < 0
• X[i] = Y[i] means (X[i] == null && Y[i] == null) || X[i].compareTo(Y[i]) == 0
• X[i] < Y[i] means Y[i] == null || X[i].compareTo(Y[i]) < 0. This corresponds to the SQL NULLS LAST clause.

Then, for two comparable Records r1 and r2, x = r1.compareTo(r2) yields:

• x = -1: if

   
      (r1[0] < r2[0])
   OR (r1[0] = r2[0] AND r1[1] < r2[1])
   OR  ...
   OR (r1[0] = r2[0] AND ... AND r1[N-1] = r2[N-1] AND r1[N] < r2[N])
   

• x = 0: if

   
   OR (r1[0] = r2[0] AND ... AND r1[N-1] = r2[N-1] AND r1[N] = r2[N])
   

• x = 1: if

   
      (r1[0] > r2[0])
   OR (r1[0] = r2[0] AND r1[1] > r2[1])
   OR  ...
   OR (r1[0] = r2[0] AND ... AND r1[N-1] = r2[N-1] AND r1[N] > r2[N])
   

Note, that the above rules correspond to the SQL ordering behaviour as illustrated in the following examples:

 
 -- A SQL ORDER BY clause, ordering all records by columns in their order
 SELECT a, b, c
 FROM my_table
 ORDER BY 1, 2, 3

 -- A row value expression comparison predicate
 SELECT *
 FROM my_table
 WHERE (a, b, c) < (1, 2, 3)
 
 

See Row1.lessThan(Row1), Row2.lessThan(Row2), ..., Row22.lessThan(Row22) for more details about row value expression comparison predicates

Alternative sorting behaviour can be achieved through Result.sortAsc(java.util.Comparator) and similar methods.

Specified by:

compareTo in interface Comparable<Record>

Specified by:

compareTo in interface Record

getValue

public final <T> T getValue(Field<T> field)

Description copied from interface: Record

Get a value from this Record, providing a field, using Fields.field(Field) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(Field) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(Field)

getValue

public final <T> T getValue(Field<?> field,
 Class<? extends T> type)

Description copied from interface: Record

Get a converted value from this Record, providing a field, using Fields.field(Field) for lookup.

[#2211] Future versions of jOOQ might remove tthis method. It is recommended to use Record.get(Field, Class) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(Field, Class)

getValue

public final <T,
U> U getValue(Field<T> field,
 Converter<? super T,? extends U> converter)

Description copied from interface: Record

Get a converted value from this Record, providing a field, using Fields.field(Field) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(Field, Converter) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(Field, Converter)

getValue

public final Object getValue(int index)

Description copied from interface: Record

Get a value from this record, providing a field index.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(int) instead.

Specified by:

getValue in interface Record

Parameters:

index - The 0-based field index in this record.

See Also:

• Record.get(int)

getValue

public final <T> T getValue(int index,
 Class<? extends T> type)

Description copied from interface: Record

Get a converted value from this record, providing a field index.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(int, Class) instead.

Specified by:

getValue in interface Record

Parameters:

index - The 0-based field index in this record.

See Also:

• Record.get(int, Class)

getValue

public final <U> U getValue(int index,
 Converter<?,? extends U> converter)

Description copied from interface: Record

Get a converted value from this record, providing a field index.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(int, Converter) instead.

Specified by:

getValue in interface Record

Parameters:

index - The 0-based field index in this record.

See Also:

• Record.get(int, Converter)

getValue

public final Object getValue(String fieldName)

Description copied from interface: Record

Get a value from this Record, providing a field name, using Fields.field(String) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(String) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(String)

getValue

public final <T> T getValue(String fieldName,
 Class<? extends T> type)

Description copied from interface: Record

Get a converted value from this Record, providing a field name, using Fields.field(String) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(String, Class) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(String, Class)

getValue

public final <U> U getValue(String fieldName,
 Converter<?,? extends U> converter)

Description copied from interface: Record

Get a converted value from this Record, providing a field name, using Fields.field(String) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(String, Converter) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(String, Converter)

getValue

public final Object getValue(Name fieldName)

Description copied from interface: Record

Get a value from this Record, providing a field name, using Fields.field(Name) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(Name) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(Name)

getValue

public final <T> T getValue(Name fieldName,
 Class<? extends T> type)

Description copied from interface: Record

Get a converted value from this Record, providing a field name, using Fields.field(Name) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(Name, Class) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(Name, Class)

getValue

public final <U> U getValue(Name fieldName,
 Converter<?,? extends U> converter)

Description copied from interface: Record

Get a converted value from this Record, providing a field name, using Fields.field(Name) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.get(Name, Converter) instead.

Specified by:

getValue in interface Record

See Also:

• Record.get(Name, Converter)

setValue

public final <T> void setValue(Field<T> field,
 T value)

Description copied from interface: Record

Set a value into this record, using Fields.field(Field) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.set(Field, Object) instead.

Specified by:

setValue in interface Record

See Also:

• Record.set(Field, Object)

setValue

public final <T,
U> void setValue(Field<T> field,
 U value,
 Converter<? extends T,? super U> converter)

Description copied from interface: Record

Set a value into this record, using Fields.field(Field) for lookup.

[#2211] Future versions of jOOQ might remove this method. It is recommended to use Record.set(Field, Object, Converter) instead.

Specified by:

setValue in interface Record

See Also:

• Record.set(Field, Object, Converter)

fieldsIncludingHidden

default Fields fieldsIncludingHidden()

Description copied from interface: Fields

Get another Fields instance that includes the hidden fields.

Specified by:

fieldsIncludingHidden in interface Fields

fields

default Field<?>[] fields()

Description copied from interface: Fields

Get all fields known to this type.

Specified by:

fields in interface Fields

fieldStream

default Stream<Field<?>> fieldStream()

Description copied from interface: Fields

Get all fields known to this type as a Stream.

Specified by:

fieldStream in interface Fields

field

default <T> Field<T> field(Field<T> field)

Description copied from interface: Fields

Get a field known to this type by field reference.

This will return:

• A field that is the same as the argument field (by identity comparison).
• A field that is equal to the argument field (exact matching fully qualified name).
• A field that is equal to the argument field (partially matching qualified name).
• A field whose name is equal to the unqualified name of the argument field.
• null otherwise.

If several fields have the same ambiguous name, the first one is returned and a warning is logged.

Specified by:

field in interface Fields

field

@Deprecated
default Field<?> field(String name)

Deprecated.

This method hides static import DSL.field(String).

Description copied from interface: Fields

Get a field known to this type by unqualified name, or null if no field is known to this type by this name.

If several fields have the same ambiguous name, the first one is returned and a warning is logged.

Specified by:

field in interface Fields

Parameters:

name - The unqualified name of the field

field

@Deprecated
default <T> Field<T> field(String name,
 Class<T> type)

Deprecated.

This method hides static import DSL.field(String, Class).

Description copied from interface: Fields

Get a field known to this type by unqualified name coerced to type using Field.coerce(Class), or null if no field is known to this type by this name.

If several fields have the same ambiguous name, the first one is returned and a warning is logged.

NOTE [#15286]: It is strongly recommended to pass only Class references of types supported by jOOQ internally, i.e. types from SQLDataType. If you're using any custom data types by means of a Converter or Binding, it's better to pass that converted DataType reference explicitly to Fields.field(Name, DataType).

Specified by:

field in interface Fields

Parameters:

name - The unqualified name of the field

type - The type to coerce the resulting field to

field

@Deprecated
default <T> Field<T> field(String name,
 DataType<T> dataType)

Deprecated.

This method hides static import DSL.field(String, DataType).

Description copied from interface: Fields

Get a field known to this type by unqualified name coerced to dataType using Field.coerce(DataType), or null if no field is known to this type by this name.

If several fields have the same ambiguous name, the first one is returned and a warning is logged.

Specified by:

field in interface Fields

Parameters:

name - The unqualified name of the field

dataType - The data type to coerce the resulting field to

field

@Deprecated
default Field<?> field(Name name)

Deprecated.

This method hides static import DSL.field(Name).

Description copied from interface: Fields

Get a field known to this type by qualified name, or null if no field is known to this type by this name.

This will return:

• A field whose name is equal to the argument field's name (exact matching fully qualified name).
• A field whose name is equal to the argument field's name (partially matching qualified name).
• A field whose name is equal to the unqualified name of the argument field.
• null otherwise.

If several fields have the same ambiguous name, the first one is returned and a warning is logged.

Specified by:

field in interface Fields

Parameters:

name - The qualified name of the field

field

@Deprecated
default <T> Field<T> field(Name name,
 Class<T> type)

Deprecated.

This method hides static import DSL.field(Name, Class).

Description copied from interface: Fields

Get a field known to this type by qualified name coerced to type using Field.coerce(Class), or null if no field is known to this type by this name.

This will return:

• A field whose name is equal to the argument field's name (exact matching fully qualified name).
• A field whose name is equal to the argument field's name (partially matching qualified name).
• A field whose name is equal to the unqualified name of the argument field.
• null otherwise.

If several fields have the same ambiguous name, the first one is returned and a warning is logged.

NOTE [#15286]: It is strongly recommended to pass only Class references of types supported by jOOQ internally, i.e. types from SQLDataType. If you're using any custom data types by means of a Converter or Binding, it's better to pass that converted DataType reference explicitly to Fields.field(Name, DataType).

Specified by:

field in interface Fields

Parameters:

name - The qualified name of the field

type - The type to coerce the resulting field to

field

@Deprecated
default <T> Field<T> field(Name name,
 DataType<T> dataType)

Deprecated.

This method hides static import DSL.field(String, DataType).

Description copied from interface: Fields

Get a field known to this type by qualified name coerced to dataType using Field.coerce(DataType), or null if no field is known to this type by this name.

This will return:

• A field whose name is equal to the argument field's name (exact matching fully qualified name).
• A field whose name is equal to the argument field's name (partially matching qualified name).
• A field whose name is equal to the unqualified name of the argument field.
• null otherwise.

If several fields have the same ambiguous name, the first one is returned and a warning is logged.

Specified by:

field in interface Fields

Parameters:

name - The qualified name of the field

dataType - The data type to coerce the resulting field to

field

default Field<?> field(int index)

Description copied from interface: Fields

Get a field known to this type by index, or null if no field is available at the index.

Specified by:

field in interface Fields

Parameters:

index - The 0-based index of the field

field

default <T> Field<T> field(int index,
 Class<T> type)

Description copied from interface: Fields

Get a field known to this type by index coerced to type using Field.coerce(Class), or null if no field is available at the index.

NOTE [#15286]: It is strongly recommended to pass only Class references of types supported by jOOQ internally, i.e. types from SQLDataType. If you're using any custom data types by means of a Converter or Binding, it's better to pass that converted DataType reference explicitly to Fields.field(Name, DataType).

Specified by:

field in interface Fields

Parameters:

index - The 0-based index of the field

type - The type to coerce the resulting field to

field

default <T> Field<T> field(int index,
 DataType<T> dataType)

Description copied from interface: Fields

Get a field known to this type by index coerced to dataType using Field.coerce(DataType), or null if no field is available at the index.

Specified by:

field in interface Fields

Parameters:

index - The 0-based index of the field

dataType - The data type to coerce the resulting field to

fields

default Field<?>[] fields(Field<?>... fields)

Description copied from interface: Fields

Get all fields, filtering by some fields.

Specified by:

fields in interface Fields

Parameters:

fields - The fields to include after looking them up via Fields.field(Field).

See Also:

• Fields.field(Field)

fields

default Field<?>[] fields(String... names)

Description copied from interface: Fields

Get all fields known to this type, filtering by some unqualified field names.

Specified by:

fields in interface Fields

Parameters:

names - The unqualified field names to include after looking them up via Fields.field(String).

See Also:

• Fields.field(String)

fields

default Field<?>[] fields(Name... names)

Description copied from interface: Fields

Get all fields known to this type, filtering by some qualified field names.

Specified by:

fields in interface Fields

Parameters:

names - The qualified field names to include after looking them up via Fields.field(Name).

See Also:

• Fields.field(Name)

fields

default Field<?>[] fields(int... indexes)

Description copied from interface: Fields

Get all fields known to this type, filtering by some field indexes.

Specified by:

fields in interface Fields

See Also:

• Fields.field(int)

indexOf

default int indexOf(Field<?> field)

Description copied from interface: Fields

Get a field's index from this type.

The lookup algorithm is the same as that of Fields.field(Field).

Specified by:

indexOf in interface Fields

Parameters:

field - The field to look for

Returns:

The field's 0-based index or -1 if the field is not known to this type.

indexOf

default int indexOf(String name)

Description copied from interface: Fields

Get a field's index from this type.

The lookup algorithm is the same as that of Fields.field(String).

Specified by:

indexOf in interface Fields

Parameters:

name - The unqualified field name to look for

Returns:

The field's 0-based index or -1 if the field is not known to this type.

indexOf

default int indexOf(Name name)

Description copied from interface: Fields

Get a field's index from this type.

The lookup algorithm is the same as that of Fields.field(Name).

Specified by:

indexOf in interface Fields

Parameters:

name - The qualified field name to look for

Returns:

The field's 0-based index or -1 if the field is not known to this type.

types

default Class<?>[] types()

Description copied from interface: Fields

Get an array of field types for fields known to this type.

Entries in the resulting array correspond to Typed.getType() for the corresponding Field in Fields.fields()

Specified by:

types in interface Fields

type

default Class<?> type(int index)

Description copied from interface: Fields

Get the field type for a given field index, or null if no field is available at the index.

Specified by:

type in interface Fields

Parameters:

index - The field's 0-based index

type

default Class<?> type(String name)

Description copied from interface: Fields

Get the field type for a given unqualified field name, or null if no field is known to this type by this name.

The lookup algorithm is the same as that of Fields.field(String).

Specified by:

type in interface Fields

Parameters:

name - The unqualified field name

type

default Class<?> type(Name name)

Description copied from interface: Fields

Get the field type for a given qualified field name, or null if no field is known to this type by this name.

The lookup algorithm is the same as that of Fields.field(Name).

Specified by:

type in interface Fields

Parameters:

name - The qualified field name

dataTypes

default DataType<?>[] dataTypes()

Description copied from interface: Fields

Get an array of field data types for this type.

Entries in the resulting array correspond to Typed.getDataType() for the corresponding Field in Fields.fields()

Specified by:

dataTypes in interface Fields

dataType

default DataType<?> dataType(int index)

Description copied from interface: Fields

Get the field data type for a given field index, or null if no field is available at the index.

Specified by:

dataType in interface Fields

Parameters:

index - The field's 0-based index

dataType

default DataType<?> dataType(String name)

Description copied from interface: Fields

Get the field data type for a given qualified field name, or null if no field is known to this type by this name.

The lookup algorithm is the same as that of Fields.field(String).

Specified by:

dataType in interface Fields

Parameters:

name - The qualified field name

dataType

default DataType<?> dataType(Name name)

Description copied from interface: Fields

Get the field data type for a given qualified field name, or null if no field is known to this type by this name.

The lookup algorithm is the same as that of Fields.field(Name).

Specified by:

dataType in interface Fields

Parameters:

name - The qualified field name

create

@Deprecated
protected final DSLContext create()

Deprecated.

- 3.11.0 - [#6720] [#6721] - Use Attachable.configuration() and Configuration.dsl() instead.

This method is used in generated code!

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

attach

public final void attach(Configuration c)

Description copied from interface: Attachable

Attach this object to a new Configuration.

Specified by:

attach in interface Attachable

Parameters:

c - A configuration or null, if you wish to detach this Attachable from its previous configuration.

detach

public final void detach()

Description copied from interface: Attachable

Detach this object from its current Configuration.

This is the same as calling attach(null).

Specified by:

detach in interface Attachable

configuration

public final Configuration configuration()

Description copied from interface: Attachable

Get the currently attached Configuration, or null if no Configuration is attached.

Specified by:

configuration in interface Attachable

format

public final String format()

Description copied from interface: Formattable

Get a simple formatted representation of this result.

This is the same as calling Formattable.format(int) with maxRows = Integer.MAX_VALUE

Specified by:

format in interface Formattable

Returns:

The formatted result

format

public final String format(int maxRecords)

Description copied from interface: Formattable

Get a simple formatted representation of this result.

Specified by:

format in interface Formattable

Parameters:

maxRecords - The maximum number of records to include in the formatted result

Returns:

The formatted result

format

public final String format(TXTFormat format)

Description copied from interface: Formattable

Get a simple formatted representation of this result.

Specified by:

format in interface Formattable

Parameters:

format - The formatting information

Returns:

The formatted result

format

public final void format(OutputStream stream)

Description copied from interface: Formattable

Like Formattable.format(), but the data is output onto an OutputStream.

Specified by:

format in interface Formattable

format

public final void format(OutputStream stream,
 int maxRecords)

Description copied from interface: Formattable

Like Formattable.format(int), but the data is output onto an OutputStream.

Specified by:

format in interface Formattable

format

public final void format(OutputStream stream,
 TXTFormat format)

Description copied from interface: Formattable

Like Formattable.format(TXTFormat), but the data is output onto an OutputStream.

Specified by:

format in interface Formattable

format

public final void format(Writer writer)

Description copied from interface: Formattable

Like Formattable.format(), but the data is output onto a Writer.

Specified by:

format in interface Formattable

format

public final void format(Writer writer,
 int maxRecords)

Description copied from interface: Formattable

Like Formattable.format(int), but the data is output onto a Writer.

Specified by:

format in interface Formattable

formatCSV

public final String formatCSV()

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(true, ',', "")

Specified by:

formatCSV in interface Formattable

Returns:

The formatted result

formatCSV

public final String formatCSV(boolean header)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(',', "")

Specified by:

formatCSV in interface Formattable

Parameters:

header - Whether to emit a CSV header line

Returns:

The formatted result

formatCSV

public final String formatCSV(char delimiter)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(true, delimiter, "")

Specified by:

formatCSV in interface Formattable

Parameters:

delimiter - The delimiter to use between records

Returns:

The formatted result

formatCSV

public final String formatCSV(boolean header,
 char delimiter)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(delimiter, "")

Specified by:

formatCSV in interface Formattable

Parameters:

header - Whether to emit a CSV header line

delimiter - The delimiter to use between records

Returns:

The formatted result

formatCSV

public final String formatCSV(char delimiter,
 String nullString)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(true, delimiter, nullString)

Specified by:

formatCSV in interface Formattable

Parameters:

delimiter - The delimiter to use between records

nullString - A special string for encoding NULL values.

Returns:

The formatted result

formatCSV

public final String formatCSV(boolean header,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

Specified by:

formatCSV in interface Formattable

Parameters:

header - Whether to emit a CSV header line

delimiter - The delimiter to use between records

nullString - A special string for encoding NULL values.

Returns:

The formatted result

formatCSV

public final String formatCSV(CSVFormat format)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

Specified by:

formatCSV in interface Formattable

Returns:

The formatted result

formatCSV

public final void formatCSV(OutputStream stream)

Description copied from interface: Formattable

Like Formattable.formatCSV(), but the data is output onto an OutputStream.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 boolean header)

Description copied from interface: Formattable

Like Formattable.formatCSV(boolean), but the data is output onto an OutputStream.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 char delimiter)

Description copied from interface: Formattable

Like Formattable.formatCSV(char), but the data is output onto an OutputStream.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 boolean header,
 char delimiter)

Description copied from interface: Formattable

Like Formattable.formatCSV(boolean, char), but the data is output onto an OutputStream.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

Like Formattable.formatCSV(char, String), but the data is output onto an OutputStream.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 boolean header,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

Like Formattable.formatCSV(boolean, char, String), but the data is output onto an OutputStream.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 CSVFormat format)

Description copied from interface: Formattable

Like Formattable.formatCSV(CSVFormat), but the data is output onto an OutputStream.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer)

Description copied from interface: Formattable

Like Formattable.formatCSV(), but the data is output onto a Writer.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 boolean header)

Description copied from interface: Formattable

Like Formattable.formatCSV(boolean), but the data is output onto a Writer.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 char delimiter)

Description copied from interface: Formattable

Like Formattable.formatCSV(char), but the data is output onto a Writer.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 boolean header,
 char delimiter)

Description copied from interface: Formattable

Like Formattable.formatCSV(boolean, char), but the data is output onto a Writer.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

Like Formattable.formatCSV(char, String), but the data is output onto a Writer.

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 boolean header,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

Like Formattable.formatCSV(boolean, char, String), but the data is output onto a Writer.

Specified by:

formatCSV in interface Formattable

formatJSON

public final String formatJSON()

Description copied from interface: Formattable

Get a simple formatted representation of this result as a JSON array of array.

The format is the following:

 {"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]]}
 

Specified by:

formatJSON in interface Formattable

Returns:

The formatted result

formatJSON

public final String formatJSON(JSONFormat format)

Description copied from interface: Formattable

Get a simple formatted representation of this result as a JSON data structure, according to the format.

Specified by:

formatJSON in interface Formattable

Returns:

The formatted result

See Also:

• JSONFormat

formatJSON

public final void formatJSON(OutputStream stream)

Description copied from interface: Formattable

Like Formattable.formatJSON(), but the data is output onto an OutputStream.

Specified by:

formatJSON in interface Formattable

formatJSON

public final void formatJSON(OutputStream stream,
 JSONFormat format)

Description copied from interface: Formattable

Like Formattable.formatJSON(JSONFormat), but the data is output onto an OutputStream.

Specified by:

formatJSON in interface Formattable

formatJSON

public final void formatJSON(Writer writer)

Description copied from interface: Formattable

Like Formattable.formatJSON(), but the data is output onto a Writer.

Specified by:

formatJSON in interface Formattable

formatXML

public final String formatXML()

Description copied from interface: Formattable

Get this result formatted as XML.

Specified by:

formatXML in interface Formattable

See Also:

• http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

formatXML

public final String formatXML(XMLFormat format)

Description copied from interface: Formattable

Get this result formatted as XML.

Specified by:

formatXML in interface Formattable

See Also:

• http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

formatXML

public final void formatXML(OutputStream stream)

Description copied from interface: Formattable

Like Formattable.formatXML(), but the data is output onto an OutputStream.

Specified by:

formatXML in interface Formattable

formatXML

public final void formatXML(OutputStream stream,
 XMLFormat format)

Description copied from interface: Formattable

Like Formattable.formatXML(XMLFormat), but the data is output onto an OutputStream.

Specified by:

formatXML in interface Formattable

formatXML

public final void formatXML(Writer writer)

Description copied from interface: Formattable

Like Formattable.formatXML(), but the data is output onto a Writer.

Specified by:

formatXML in interface Formattable

formatChart

public final String formatChart()

Description copied from interface: Formattable

Get this result as an ASCII chart.

Specified by:

formatChart in interface Formattable

See Also:

• Formattable.formatChart(ChartFormat)

formatChart

public final String formatChart(ChartFormat format)

Description copied from interface: Formattable

Get this result as an ASCII chart.

When running a query like this:

 String chart =
 create.select(
            BOOK_TO_BOOK_STORE.BOOK_STORE_NAME,
            count(BOOK_TO_BOOK_STORE.BOOK_ID).as("books")
        )
        .from(BOOK_TO_BOOK_STORE)
        .groupBy(BOOK_TO_BOOK_STORE.BOOK_STORE_NAME)
        .fetch()
        .formatChart();
 

Where the formatted result would look like this:

 +-------------------------+-----+
 |BOOK_STORE_NAME          |books|
 +-------------------------+-----+
 |Buchhandlung im Volkshaus|    1|
 |Ex Libris                |    2|
 |Orell Füssli             |    3|
 +-------------------------+-----+
 

Then the chart might look something like this:

 3.00|                                                  █████████████████████████
 2.91|                                                  █████████████████████████
 2.82|                                                  █████████████████████████
 2.73|                                                  █████████████████████████
 2.64|                                                  █████████████████████████
 2.55|                                                  █████████████████████████
 2.45|                                                  █████████████████████████
 2.36|                                                  █████████████████████████
 2.27|                                                  █████████████████████████
 2.18|                                                  █████████████████████████
 2.09|                                                  █████████████████████████
 2.00|                         ██████████████████████████████████████████████████
 1.91|                         ██████████████████████████████████████████████████
 1.82|                         ██████████████████████████████████████████████████
 1.73|                         ██████████████████████████████████████████████████
 1.64|                         ██████████████████████████████████████████████████
 1.55|                         ██████████████████████████████████████████████████
 1.45|                         ██████████████████████████████████████████████████
 1.36|                         ██████████████████████████████████████████████████
 1.27|                         ██████████████████████████████████████████████████
 1.18|                         ██████████████████████████████████████████████████
 1.09|                         ██████████████████████████████████████████████████
 1.00|███████████████████████████████████████████████████████████████████████████
 ----+---------------------------------------------------------------------------
     | Buchhandlung im Volkshaus         Ex Libris               Orell Füssli
 

It is possible to specify a variety of ChartFormat formatting specifications, such as the width, height, display type (default, stacked, 100% stacked), the column index of the category and value columns, etc.

Specified by:

formatChart in interface Formattable

See Also:

• Formattable.formatChart(ChartFormat)

formatChart

public final void formatChart(OutputStream stream)

Description copied from interface: Formattable

Like Formattable.formatChart(), but the data is output onto an OutputStream.

Specified by:

formatChart in interface Formattable

formatChart

public final void formatChart(OutputStream stream,
 ChartFormat format)

Description copied from interface: Formattable

Like Formattable.formatChart(ChartFormat), but the data is output onto an OutputStream.

Specified by:

formatChart in interface Formattable

formatChart

public final void formatChart(Writer writer)

Description copied from interface: Formattable

Like Formattable.formatChart(), but the data is output onto a Writer.

Specified by:

formatChart in interface Formattable

formatInsert

public final String formatInsert()

Description copied from interface: Formattable

Get this result as a set of INSERT statements.

This uses the the first record's TableRecord.getTable(), if the first record is a TableRecord. Otherwise, this generates INSERT statements into an "UNKNOWN_TABLE". In both cases, the Fields.fields() are used for column names.

Specified by:

formatInsert in interface Formattable

formatInsert

public final void formatInsert(OutputStream stream)

Description copied from interface: Formattable

Like Formattable.formatInsert(), but the data is output onto an OutputStream.

Specified by:

formatInsert in interface Formattable

formatInsert

public final String formatInsert(Table<?> table,
 Field<?>... f)

Description copied from interface: Formattable

Get this result as a set of INSERT statements.

This explicitly specifies the table (and optionally the fields) to insert into. If the fields argument is left empty, the Fields.fields() are used, instead.

Specified by:

formatInsert in interface Formattable

formatInsert

public final void formatInsert(OutputStream stream,
 Table<?> table,
 Field<?>... f)

Description copied from interface: Formattable

Like Formattable.formatInsert(Table, Field...), but the data is output onto an OutputStream.

Specified by:

formatInsert in interface Formattable

formatHTML

public final String formatHTML()

Description copied from interface: Formattable

Get a simple formatted representation of this result as HTML.

The HTML code is formatted as follows:

 <table>
   <thead>
     <tr>
       <th>field-1</th>
       <th>field-2</th>
       ...
       <th>field-n</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <th>value-1-1</th>
       <th>value-1-2</th>
       ...
       <th>value-1-n</th>
     </tr>
     <tr>
       <th>value-2-1</th>
       <th>value-2-2</th>
       ...
       <th>value-2-n</th>
     </tr>
     ...
   </tbody>
 </table>
 

Specified by:

formatHTML in interface Formattable

Returns:

The formatted result

formatHTML

public final void formatHTML(OutputStream stream)

Description copied from interface: Formattable

Like Formattable.formatHTML(), but the data is output onto an OutputStream.

Specified by:

formatHTML in interface Formattable

intoXML

public final Document intoXML()

Description copied from interface: Formattable

Get this result as XML.

Specified by:

intoXML in interface Formattable

See Also:

• Formattable.formatXML()
• http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

intoXML

public final <H extends ContentHandler> H intoXML(H handler)
                                           throws SAXException

Description copied from interface: Formattable

Get this result as XML using a SAX ContentHandler.

Specified by:

intoXML in interface Formattable

Parameters:

handler - The custom content handler.

Returns:

The argument content handler is returned for convenience.

Throws:

SAXException

See Also:

• Formattable.formatXML()
• http://www.jooq.org/xsd/jooq-export-3.10.0.xsd