org.apache.commons.dbutils.handlers.MapHandler 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.Map;
import org.apache.commons.dbutils.ResultSetHandler;
import org.apache.commons.dbutils.RowProcessor;
/**
* ResultSetHandler implementation that converts the first
* ResultSet row into a Map. This class is thread
* safe.
*
* @see org.apache.commons.dbutils.ResultSetHandler
*/
public class MapHandler implements ResultSetHandler> {
/**
* The RowProcessor implementation to use when converting rows
* into Maps.
*/
private final RowProcessor convert;
/**
* Creates a new instance of MapHandler using a
* BasicRowProcessor for conversion.
*/
public MapHandler() {
this(ArrayHandler.ROW_PROCESSOR);
}
/**
* Creates a new instance of MapHandler.
*
* @param convert The RowProcessor implementation
* to use when converting rows into Maps.
*/
public MapHandler(RowProcessor convert) {
super();
this.convert = convert;
}
/**
* Converts the first row in the ResultSet into a
* Map.
* @param rs ResultSet to process.
* @return A Map with the values from the first row or
* null if there are no rows in the ResultSet.
*
* @throws SQLException if a database access error occurs
*
* @see org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
*/
@Override
public Map handle(ResultSet rs) throws SQLException {
return rs.next() ? this.convert.toMap(rs) : null;
}
}