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.List;
22
23 import org.apache.commons.dbutils.ResultSetHandler;
24 import org.apache.commons.dbutils.RowProcessor;
25
26 /**
27 * {@code ResultSetHandler} implementation that converts a
28 * {@code ResultSet} into a {@code List} of beans. This class is
29 * thread safe.
30 *
31 * @param <T> the target bean type
32 * @see org.apache.commons.dbutils.ResultSetHandler
33 */
34 public class BeanListHandler<T> implements ResultSetHandler<List<T>> {
35
36 /**
37 * The Class of beans produced by this handler.
38 */
39 private final Class<? extends T> type;
40
41 /**
42 * The RowProcessor implementation to use when converting rows
43 * into beans.
44 */
45 private final RowProcessor convert;
46
47 /**
48 * Creates a new instance of BeanListHandler.
49 *
50 * @param type The Class that objects returned from {@code handle()}
51 * are created from.
52 */
53 public BeanListHandler(final Class<? extends T> type) {
54 this(type, ArrayHandler.ROW_PROCESSOR);
55 }
56
57 /**
58 * Creates a new instance of BeanListHandler.
59 *
60 * @param type The Class that objects returned from {@code handle()}
61 * are created from.
62 * @param convert The {@code RowProcessor} implementation
63 * to use when converting rows into beans.
64 */
65 public BeanListHandler(final Class<? extends T> type, final RowProcessor convert) {
66 this.type = type;
67 this.convert = convert;
68 }
69
70 /**
71 * Convert the whole {@code ResultSet} into a List of beans with
72 * the {@code Class} given in the constructor.
73 *
74 * @param resultSet The {@code ResultSet} to handle.
75 *
76 * @return A List of beans, never {@code null}.
77 *
78 * @throws SQLException if a database access error occurs
79 * @see org.apache.commons.dbutils.RowProcessor#toBeanList(ResultSet, Class)
80 */
81 @Override
82 public List<T> handle(final ResultSet resultSet) throws SQLException {
83 return this.convert.toBeanList(resultSet, type);
84 }
85 }