Package io.micronaut.data.runtime.mapper

Interface ResultReader<RS,IDX>

Type Parameters:
RS - The result set
IDX - The index type
All Known Implementing Classes:
ColumnIndexCallableResultReader, ColumnIndexR2dbcResultReader, ColumnIndexResultSetReader, ColumnNameCallableResultReader, ColumnNameR2dbcResultReader, ColumnNameResultSetReader
public interface ResultReader<RS,IDX>
A result reader is a type that is capable of reading data from the given result set type.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T> T
    convertRequired(@NonNull Object value, io.micronaut.core.type.Argument<T> type)
    Convert the value to the given type.
    default <T> T
    convertRequired(@NonNull Object value, Class<T> type)
    Convert the value to the given type.
    default io.micronaut.core.convert.ConversionService
    getConversionService()
    Get conversion service.
    <T> T
    getRequiredValue(RS resultSet, IDX name, Class<T> type)
    Get a value from the given result set for the given name and type.
    boolean
    next(RS resultSet)
    Move the index to the next result if possible.
    default BigDecimal
    readBigDecimal(RS resultSet, IDX name)
    Read a BigDecimal value for the given name.
    default boolean
    readBoolean(RS resultSet, IDX name)
    Read a boolean value for the given name.
    default byte
    readByte(RS resultSet, IDX name)
    Read a byte value for the given name.
    default byte[]
    readBytes(RS resultSet, IDX name)
    Read a byte[] value for the given name.
    default char
    readChar(RS resultSet, IDX name)
    Read a char value for the given name.
    default Date
    readDate(RS resultSet, IDX name)
    Read a date value for the given name.
    default double
    readDouble(RS resultSet, IDX name)
    Read a double value for the given name.
    default @Nullable Object
    readDynamic(RS resultSet, IDX index, @NonNull DataType dataType)
    Read a value dynamically using the result set and the given name and data type.
    default float
    readFloat(RS resultSet, IDX name)
    Read a float value for the given name.
    default int
    readInt(RS resultSet, IDX name)
    Read a int value for the given name.
    default long
    readLong(RS resultSet, IDX name)
    Read a long value for the given name.
    default short
    readShort(RS resultSet, IDX name)
    Read a short value for the given name.
    default @Nullable String
    readString(RS resultSet, IDX name)
    Read a string value for the given name.
    default Time
    readTime(RS resultSet, IDX index)
    Read a time value for the given index.
    default Date
    readTimestamp(RS resultSet, IDX index)
    Read a timestamp value for the given index.
    default @Nullable UUID
    readUUID(RS resultSet, IDX name)
    Read a UUID value for the given name.

  • Method Details

    • convertRequired

      default <T> T convertRequired(@NonNull @NonNull Object value, Class<T> type)
      Convert the value to the given type.
      Type Parameters:
      T - The generic type
      Parameters:
      value - The value
      type - The type
      Returns:
      The converted value
      Throws:
      DataAccessException - if the value cannot be converted

    • convertRequired

      default <T> T convertRequired(@NonNull @NonNull Object value, io.micronaut.core.type.Argument<T> type)
      Convert the value to the given type.
      Type Parameters:
      T - The generic type
      Parameters:
      value - The value
      type - The type
      Returns:
      The converted value
      Throws:
      DataAccessException - if the value cannot be converted

    • getRequiredValue

      @Nullable <T> T getRequiredValue(RS resultSet, IDX name, Class<T> type) throws DataAccessException
      Get a value from the given result set for the given name and type.
      Type Parameters:
      T - The generic type
      Parameters:
      resultSet - The result set
      name - The name
      type - The type
      Returns:
      The value
      Throws:
      DataAccessException - if the value cannot be read

    • next

      boolean next(RS resultSet)
      Move the index to the next result if possible.
      Parameters:
      resultSet - The result set
      Returns:
      The next result

    • readDynamic

      @Nullable default @Nullable Object readDynamic(@NonNull RS resultSet, @NonNull IDX index, @NonNull @NonNull DataType dataType)
      Read a value dynamically using the result set and the given name and data type.
      Parameters:
      resultSet - The result set
      index - The name
      dataType - The data type
      Returns:
      The value, can be null
      Throws:
      DataAccessException - if the value cannot be read

    • readLong

      default long readLong(RS resultSet, IDX name)
      Read a long value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The long value

    • readChar

      default char readChar(RS resultSet, IDX name)
      Read a char value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The char value

    • readDate

      default Date readDate(RS resultSet, IDX name)
      Read a date value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The char value

    • readTimestamp

      default Date readTimestamp(RS resultSet, IDX index)
      Read a timestamp value for the given index.
      Parameters:
      resultSet - The result set
      index - The index (such as the column name)
      Returns:
      The char value

    • readTime

      default Time readTime(RS resultSet, IDX index)
      Read a time value for the given index.
      Parameters:
      resultSet - The result set
      index - The index (such as the column name)
      Returns:
      The char value

    • readString

      @Nullable default @Nullable String readString(RS resultSet, IDX name)
      Read a string value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The string value

    • readUUID

      @Nullable default @Nullable UUID readUUID(RS resultSet, IDX name)
      Read a UUID value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The string value

    • readInt

      default int readInt(RS resultSet, IDX name)
      Read a int value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The int value

    • readBoolean

      default boolean readBoolean(RS resultSet, IDX name)
      Read a boolean value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The boolean value

    • readFloat

      default float readFloat(RS resultSet, IDX name)
      Read a float value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The float value

    • readByte

      default byte readByte(RS resultSet, IDX name)
      Read a byte value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The byte value

    • readShort

      default short readShort(RS resultSet, IDX name)
      Read a short value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The short value

    • readDouble

      default double readDouble(RS resultSet, IDX name)
      Read a double value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The double value

    • readBigDecimal

      default BigDecimal readBigDecimal(RS resultSet, IDX name)
      Read a BigDecimal value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The BigDecimal value

    • readBytes

      default byte[] readBytes(RS resultSet, IDX name)
      Read a byte[] value for the given name.
      Parameters:
      resultSet - The result set
      name - The name (such as the column name)
      Returns:
      The byte[] value

    • getConversionService

      default io.micronaut.core.convert.ConversionService getConversionService()
      Get conversion service.
      Returns:
      the instance of ConversionService