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 19 import java.sql.ResultSet; 20 import java.sql.SQLException; 21 import java.util.Map; 22 23 import org.apache.commons.dbutils.RowProcessor; 24 25 /** 26 * {@code ResultSetHandler} implementation that converts a 27 * {@code ResultSet} into a {@code List} of {@code Map}s. 28 * This class is thread safe. 29 * 30 * @see org.apache.commons.dbutils.ResultSetHandler 31 */ 32 public class MapListHandler extends AbstractListHandler<Map<String, Object>> { 33 34 /** 35 * The RowProcessor implementation to use when converting rows 36 * into Maps. 37 */ 38 private final RowProcessor convert; 39 40 /** 41 * Creates a new instance of MapListHandler using a 42 * {@code BasicRowProcessor} for conversion. 43 */ 44 public MapListHandler() { 45 this(ArrayHandler.ROW_PROCESSOR); 46 } 47 48 /** 49 * Creates a new instance of MapListHandler. 50 * 51 * @param convert The {@code RowProcessor} implementation 52 * to use when converting rows into Maps. 53 */ 54 public MapListHandler(final RowProcessor convert) { 55 this.convert = convert; 56 } 57 58 /** 59 * Converts the {@code ResultSet} row into a {@code Map} object. 60 * @param resultSet {@code ResultSet} to process. 61 * @return A {@code Map}, never null. 62 * 63 * @throws SQLException if a database access error occurs 64 * 65 * @see org.apache.commons.dbutils.handlers.AbstractListHandler#handle(ResultSet) 66 */ 67 @Override 68 protected Map<String, Object> handleRow(final ResultSet resultSet) throws SQLException { 69 return this.convert.toMap(resultSet); 70 } 71 72 }