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