org.skife.jdbi.v2.util.StringMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdbi Show documentation

jDBI is designed to provide convenient tabular data access in Java(tm). It uses the Java collections framework for query results, provides a convenient means of externalizing sql statements, and provides named parameter support for any database being used.

There is a newer version: 2.78

Show newest version

/*
 * Licensed 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.skife.jdbi.v2.util;

import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * Convenience ResultSetMapper for extracting a single value result
 * from a query.
 *
 * @deprecated Use {@link StringColumnMapper} instead.
 */
@Deprecated
public class StringMapper extends TypedMapper
{

    /**
     * An instance which extracts value from the first field
     */
    public static final StringMapper FIRST = new StringMapper(1);


    /**
     * Create a new instance which extracts the value from the first column
     */
    public StringMapper()
    {
        super();
    }

    /**
     * Create a new instance which extracts the value positionally
     * in the result set
     *
     * @param index 1 based column index into the result set
     */
    public StringMapper(int index)
    {
        super(index);
    }

    /**
     * Create a new instance which extracts the value by name or alias from the result set
     *
     * @param name The name or alias for the field
     */
    public StringMapper(String name)
    {
        super(name);
    }

    @Override
    protected String extractByName(ResultSet r, String name) throws SQLException
    {
        return r.getString(name);
    }

    @Override
    protected String extractByIndex(ResultSet r, int index) throws SQLException
    {
        return r.getString(index);
    }
}