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.ArrayList; 22 import java.util.List; 23 24 import org.apache.commons.dbutils.ResultSetHandler; 25 26 /** 27 * Abstract class that simplify development of <code>ResultSetHandler</code> 28 * classes that convert <code>ResultSet</code> into <code>List</code>. 29 * 30 * @see org.apache.commons.dbutils.ResultSetHandler 31 */ 32 public abstract class AbstractListHandler implements ResultSetHandler { 33 /** 34 * Whole <code>ResultSet</code> handler. It produce <code>List</code> as 35 * result. To convert individual rows into Java objects it uses 36 * <code>handleRow(ResultSet)</code> method. 37 * 38 * @see #handleRow(ResultSet) 39 */ 40 public Object handle(ResultSet rs) throws SQLException { 41 List rows = new ArrayList(); 42 while (rs.next()) { 43 rows.add(this.handleRow(rs)); 44 } 45 return rows; 46 } 47 48 /** 49 * Row handler. Method converts current row into some Java object. 50 * 51 * @param rs <code>ResultSet</code> to process. 52 * @return row processing result 53 * @throws SQLException error occurs 54 */ 55 protected abstract Object handleRow(ResultSet rs) throws SQLException; 56 }