com.jcabi.jdbc.ListOutcome Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jcabi-jdbc Show documentation
The newest version!
/*
 * Copyright (c) 2012-2023, jcabi.com
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met: 1) Redistributions of source code must retain the above
 * copyright notice, this list of conditions and the following
 * disclaimer. 2) Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided
 * with the distribution. 3) Neither the name of the jcabi.com nor
 * the names of its contributors may be used to endorse or promote
 * products derived from this software without specific prior written
 * permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.jcabi.jdbc;

import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.LinkedList;
import java.util.List;
import lombok.EqualsAndHashCode;
import lombok.ToString;

/**
 * Outcome that returns a list.
 *
 * Use it when you need a full collection:
 *
 * 
 Collection&lgt;User> users = new JdbcSession(source)
 *   .sql("SELECT * FROM user")
 *   .select(
 *     new ListOutcome<User>(
 *       new ListOutcome.Mapping<User>() {
 *         @Override
 *         public User map(final ResultSet rset) throws SQLException {
 *           return new User.Simple(rset.getLong(1), rset.getString(2));
 *         }
 *       }
 *     )
 *   );
 *
 * @since 0.13
 * @param  Type of items
 */
@ToString
@EqualsAndHashCode(of = "mapping")
public final class ListOutcome implements Outcome> {

    /**
     * Mapping.
     */
    private final transient ListOutcome.Mapping mapping;

    /**
     * Public ctor.
     * @param mpg Mapping
     */
    public ListOutcome(final ListOutcome.Mapping mpg) {
        this.mapping = mpg;
    }

    @Override
    public List handle(final ResultSet rset, final Statement stmt)
        throws SQLException {
        final List result = new LinkedList<>();
        while (rset.next()) {
            result.add(this.mapping.map(rset));
        }
        return result;
    }

}