Module org.jooq
Package org.jooq

Interface Fields

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @Nullable DataType<?> dataType​(int index)
      Get the field data type for a given field index.
      @Nullable DataType<?> dataType​(String name)
      Get the field data type for a given qualified field name.
      @Nullable DataType<?> dataType​(Name name)
      Get the field data type for a given qualified field name.
      @NotNull DataType<?>[] dataTypes()
      Get an array of field data types for this type.
      @Nullable Field<?> field​(int index)
      Get a field by index.
      <T> @Nullable Field<T> field​(int index, Class<T> type)
      Get a field by index coerced to type.
      <T> @Nullable Field<T> field​(int index, DataType<T> dataType)
      Get a field by index coerced to dataType.
      @Nullable Field<?> field​(String name)
      Get a field by unqualified name.
      <T> @Nullable Field<T> field​(String name, Class<T> type)
      Get a field by unqualified name coerced to type.
      <T> @Nullable Field<T> field​(String name, DataType<T> dataType)
      Get a field by unqualified name coerced to dataType.
      <T> @Nullable Field<T> field​(Field<T> field)
      Get a field by field reference.
      @Nullable Field<?> field​(Name name)
      Get a field by qualified name.
      <T> @Nullable Field<T> field​(Name name, Class<T> type)
      Get a field by qualified name coerced to type.
      <T> @Nullable Field<T> field​(Name name, DataType<T> dataType)
      Get a field by qualified name coerced to dataType.
      @NotNull Field<?>[] fields()
      Get all fields.
      @NotNull Field<?>[] fields​(int... indexes)
      Get all fields, filtering by some field indexes.
      @NotNull Field<?>[] fields​(String... names)
      Get all fields, filtering by some unqualified field names.
      @NotNull Field<?>[] fields​(Field<?>... fields)
      Get all fields, filtering by some fields.
      @NotNull Field<?>[] fields​(Name... names)
      Get all fields, filtering by some qualified field names.
      @NotNull Row fieldsRow()
      Get all fields as a Row.
      @NotNull Stream<Field<?>> fieldStream()
      Get this table's fields as a Stream, if this table knows its field references.
      int indexOf​(String name)
      Get a field's index from this type.
      int indexOf​(Field<?> field)
      Get a field's index from this type.
      int indexOf​(Name name)
      Get a field's index from this type.
      @Nullable Class<?> type​(int index)
      Get the field type for a given field index.
      @Nullable Class<?> type​(String name)
      Get the field type for a given unqualified field name.
      @Nullable Class<?> type​(Name name)
      Get the field type for a given qualified field name.
      @NotNull Class<?>[] types()
      Get an array of field types for this type.
    • Method Detail

      • fields

        @NotNull
        @NotNull Field<?>[] fields()
        Get all fields.
      • fieldsRow

        @NotNull
        @NotNull Row fieldsRow()
        Get all fields as a Row.
      • fieldStream

        @NotNull
        @NotNull Stream<Field<?>> fieldStream()
        Get this table's fields as a Stream, if this table knows its field references.
      • field

        @Nullable
        <T> @Nullable Field<T> field​(Field<T> field)
        Get a field 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 name of the argument field.
        • null otherwise.
        If several fields have the same name, the first one is returned and a warning is logged.
      • field

        @Nullable
        @Nullable Field<?> field​(String name)
        Get a field by unqualified name.
        Parameters:
        name - The unqualified name of the field
      • field

        @Nullable
        <T> @Nullable Field<T> field​(String name,
                                     Class<T> type)
        Get a field by unqualified name coerced to type.
        Parameters:
        name - The unqualified name of the field
        type - The type to coerce the resulting field to
      • field

        @Nullable
        <T> @Nullable Field<T> field​(String name,
                                     DataType<T> dataType)
        Get a field by unqualified name coerced to dataType.
        Parameters:
        name - The unqualified name of the field
        dataType - The data type to coerce the resulting field to
      • field

        @Nullable
        @Nullable Field<?> field​(Name name)
        Get a field by qualified name.
        Parameters:
        name - The qualified name of the field
      • field

        @Nullable
        <T> @Nullable Field<T> field​(Name name,
                                     Class<T> type)
        Get a field by qualified name coerced to type.
        Parameters:
        name - The qualified name of the field
        type - The type to coerce the resulting field to
      • field

        @Nullable
        <T> @Nullable Field<T> field​(Name name,
                                     DataType<T> dataType)
        Get a field by qualified name coerced to dataType.
        Parameters:
        name - The qualified name of the field
        dataType - The data type to coerce the resulting field to
      • field

        @Nullable
        @Nullable Field<?> field​(int index)
        Get a field by index.
        Parameters:
        index - The 0-based index of the field
      • field

        @Nullable
        <T> @Nullable Field<T> field​(int index,
                                     Class<T> type)
        Get a field by index coerced to type.
        Parameters:
        index - The 0-based index of the field
        type - The type to coerce the resulting field to
      • field

        @Nullable
        <T> @Nullable Field<T> field​(int index,
                                     DataType<T> dataType)
        Get a field by index coerced to dataType.
        Parameters:
        index - The 0-based index of the field
        dataType - The data type to coerce the resulting field to
      • fields

        @NotNull
        @NotNull Field<?>[] fields​(Field<?>... fields)
        Get all fields, filtering by some fields.
        Parameters:
        fields - The fields to include after looking them up via field(Field).
        See Also:
        field(Field)
      • fields

        @NotNull
        @NotNull Field<?>[] fields​(String... names)
        Get all fields, filtering by some unqualified field names.
        Parameters:
        names - The unqualified field names to include after looking them up via field(String).
        See Also:
        field(String)
      • fields

        @NotNull
        @NotNull Field<?>[] fields​(Name... names)
        Get all fields, filtering by some qualified field names.
        Parameters:
        names - The qualified field names to include after looking them up via field(Name).
        See Also:
        field(Name)
      • fields

        @NotNull
        @NotNull Field<?>[] fields​(int... indexes)
        Get all fields, filtering by some field indexes.
        Parameters:
        names - The 0-based field indexes to include after looking them up via field(int).
        See Also:
        field(int)
      • indexOf

        int indexOf​(Field<?> field)
        Get a field's index from this type.
        Parameters:
        field - The field to look for
        Returns:
        The field's 0-based index or -1 if the field is not available.
      • indexOf

        int indexOf​(String name)
        Get a field's index from this type.
        Parameters:
        name - The unqualified field name to look for
        Returns:
        The field's 0-based index or -1 if the field is not available.
      • indexOf

        int indexOf​(Name name)
        Get a field's index from this type.
        Parameters:
        name - The qualified field name to look for
        Returns:
        The field's 0-based index or -1 if the field is not available.
      • types

        @NotNull
        @NotNull Class<?>[] types()
        Get an array of field types for this type.

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

      • type

        @Nullable
        @Nullable Class<?> type​(int index)
        Get the field type for a given field index.
        Parameters:
        index - The field's 0-based index
      • type

        @Nullable
        @Nullable Class<?> type​(String name)
        Get the field type for a given unqualified field name.
        Parameters:
        name - The unqualified field name
      • type

        @Nullable
        @Nullable Class<?> type​(Name name)
        Get the field type for a given qualified field name.
        Parameters:
        name - The qualified field name
      • dataTypes

        @NotNull
        @NotNull DataType<?>[] dataTypes()
        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()

      • dataType

        @Nullable
        @Nullable DataType<?> dataType​(int index)
        Get the field data type for a given field index.
        Parameters:
        index - The field's 0-based index
      • dataType

        @Nullable
        @Nullable DataType<?> dataType​(String name)
        Get the field data type for a given qualified field name.
        Parameters:
        name - The qualified field name
      • dataType

        @Nullable
        @Nullable DataType<?> dataType​(Name name)
        Get the field data type for a given qualified field name.
        Parameters:
        name - The qualified field name