Class FieldMapper<T>

java.lang.Object
org.jdbi.v3.core.mapper.reflect.FieldMapper<T>
All Implemented Interfaces:
RowMapper<T>
public final class FieldMapper<T> extends Object implements RowMapper<T>
A row mapper which maps the columns in a statement into an object, using reflection to set fields on the object. All declared fields of the class and its superclasses may be set. Nested properties are supported via the Nested annotation. The mapped class must have a default constructor.

  • Method Details

    • factory

      public static RowMapperFactory factory(Class<?> type)
      Returns a mapper factory that maps to the given bean class
      Parameters:
      type - the mapped class
      Returns:
      a mapper factory that maps to the given bean class

    • factory

      public static RowMapperFactory factory(Class<?> type, String prefix)
      Returns a mapper factory that maps to the given bean class
      Parameters:
      type - the mapped class
      prefix - the column name prefix for each mapped field
      Returns:
      a mapper factory that maps to the given bean class

    • of

      public static <T> RowMapper<T> of(Class<T> type)
      Returns a mapper for the given bean class
      Type Parameters:
      T - the type to map
      Parameters:
      type - the mapped class
      Returns:
      a mapper for the given bean class

    • of

      public static <T> RowMapper<T> of(Class<T> type, String prefix)
      Returns a mapper for the given bean class
      Type Parameters:
      T - the type to map
      Parameters:
      type - the mapped class
      prefix - the column name prefix for each mapped field
      Returns:
      a mapper for the given bean class

    • map

      public T map(ResultSet rs, StatementContext ctx) throws SQLException
      Description copied from interface: RowMapper
      Map the current row of the result set. This method should not cause the result set to advance; allow Jdbi to do that, please.
      Specified by:
      map in interface RowMapper<T>
      Parameters:
      rs - the result set being iterated
      ctx - the statement context
      Returns:
      the value to produce for this row
      Throws:
      SQLException - if anything goes wrong go ahead and let this percolate; Jdbi will handle it

    • specialize

      public RowMapper<T> specialize(ResultSet rs, StatementContext ctx) throws SQLException
      Description copied from interface: RowMapper
      Returns a specialized row mapper, optimized for the given result set.

      Before mapping the result set from a SQL statement; Jdbi will first call this method to obtain a specialized instance. The returned mapper will then be used to map the result set rows, and discarded.

      Implementing this method is optional; the default implementation returns this. Implementors might choose to override this method to improve performance, e.g. by matching up column names to properties once for the entire result set, rather than repeating the process for every row.

      Specified by:
      specialize in interface RowMapper<T>
      Parameters:
      rs - the result set to specialize over
      ctx - the statement context to specialize over
      Returns:
      a row mapper equivalent to this one, possibly specialized.
      Throws:
      SQLException - if anything goes wrong go ahead and let this percolate; Jdbi will handle it
      See Also:

    • checkPropagateNullAnnotation

      public static boolean checkPropagateNullAnnotation(Field field)