View Javadoc

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