MapListHandler.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.apache.commons.dbutils.handlers;

  18. import java.sql.ResultSet;
  19. import java.sql.SQLException;
  20. import java.util.Map;

  21. import org.apache.commons.dbutils.RowProcessor;

  22. /**
  23.  * {@code ResultSetHandler} implementation that converts a
  24.  * {@code ResultSet} into a {@code List} of {@code Map}s.
  25.  * This class is thread safe.
  26.  *
  27.  * @see org.apache.commons.dbutils.ResultSetHandler
  28.  */
  29. public class MapListHandler extends AbstractListHandler<Map<String, Object>> {

  30.     /**
  31.      * The RowProcessor implementation to use when converting rows
  32.      * into Maps.
  33.      */
  34.     private final RowProcessor convert;

  35.     /**
  36.      * Creates a new instance of MapListHandler using a
  37.      * {@code BasicRowProcessor} for conversion.
  38.      */
  39.     public MapListHandler() {
  40.         this(ArrayHandler.ROW_PROCESSOR);
  41.     }

  42.     /**
  43.      * Creates a new instance of MapListHandler.
  44.      *
  45.      * @param convert The {@code RowProcessor} implementation
  46.      * to use when converting rows into Maps.
  47.      */
  48.     public MapListHandler(final RowProcessor convert) {
  49.         this.convert = convert;
  50.     }

  51.     /**
  52.      * Converts the {@code ResultSet} row into a {@code Map} object.
  53.      * @param resultSet {@code ResultSet} to process.
  54.      * @return A {@code Map}, never null.
  55.      *
  56.      * @throws SQLException if a database access error occurs
  57.      *
  58.      * @see org.apache.commons.dbutils.handlers.AbstractListHandler#handle(ResultSet)
  59.      */
  60.     @Override
  61.     protected Map<String, Object> handleRow(final ResultSet resultSet) throws SQLException {
  62.         return this.convert.toMap(resultSet);
  63.     }

  64. }