org.apache.commons.dbutils.handlers.BeanListHandler Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.dbutils.handlers;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;
import org.apache.commons.dbutils.ResultSetHandler;
import org.apache.commons.dbutils.RowProcessor;
/**
* ResultSetHandler implementation that converts a
* ResultSet into a List of beans. This class is
* thread safe.
*
* @param the target bean type
* @see org.apache.commons.dbutils.ResultSetHandler
*/
public class BeanListHandler implements ResultSetHandler> {
/**
* The Class of beans produced by this handler.
*/
private final Class type;
/**
* The RowProcessor implementation to use when converting rows
* into beans.
*/
private final RowProcessor convert;
/**
* Creates a new instance of BeanListHandler.
*
* @param type The Class that objects returned from handle()
* are created from.
*/
public BeanListHandler(Class type) {
this(type, ArrayHandler.ROW_PROCESSOR);
}
/**
* Creates a new instance of BeanListHandler.
*
* @param type The Class that objects returned from handle()
* are created from.
* @param convert The RowProcessor implementation
* to use when converting rows into beans.
*/
public BeanListHandler(Class type, RowProcessor convert) {
this.type = type;
this.convert = convert;
}
/**
* Convert the whole ResultSet into a List of beans with
* the Class given in the constructor.
*
* @param rs The ResultSet to handle.
*
* @return A List of beans, never null.
*
* @throws SQLException if a database access error occurs
* @see org.apache.commons.dbutils.RowProcessor#toBeanList(ResultSet, Class)
*/
@Override
public List handle(ResultSet rs) throws SQLException {
return this.convert.toBeanList(rs, type);
}
}