1 /*
2 * Copyright (c) 2012-2023, jcabi.com
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met: 1) Redistributions of source code must retain the above
8 * copyright notice, this list of conditions and the following
9 * disclaimer. 2) Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution. 3) Neither the name of the jcabi.com nor
13 * the names of its contributors may be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package com.jcabi.jdbc;
31
32 import java.sql.ResultSet;
33 import java.sql.SQLException;
34 import java.sql.Statement;
35 import java.util.LinkedList;
36 import java.util.List;
37 import lombok.EqualsAndHashCode;
38 import lombok.ToString;
39
40 /**
41 * Outcome that returns a list.
42 *
43 * <p>Use it when you need a full collection:
44 *
45 * <pre> Collection&lgt;User> users = new JdbcSession(source)
46 * .sql("SELECT * FROM user")
47 * .select(
48 * new ListOutcome<User>(
49 * new ListOutcome.Mapping<User>() {
50 * @Override
51 * public User map(final ResultSet rset) throws SQLException {
52 * return new User.Simple(rset.getLong(1), rset.getString(2));
53 * }
54 * }
55 * )
56 * );</pre>
57 *
58 * @since 0.13
59 * @param <T> Type of items
60 */
61 @ToString
62 @EqualsAndHashCode(of = "mapping")
63 public final class ListOutcome<T> implements Outcome<List<T>> {
64
65 /**
66 * Mapping.
67 */
68 private final transient ListOutcome.Mapping<T> mapping;
69
70 /**
71 * Public ctor.
72 * @param mpg Mapping
73 */
74 public ListOutcome(final ListOutcome.Mapping<T> mpg) {
75 this.mapping = mpg;
76 }
77
78 @Override
79 public List<T> handle(final ResultSet rset, final Statement stmt)
80 throws SQLException {
81 final List<T> result = new LinkedList<>();
82 while (rset.next()) {
83 result.add(this.mapping.map(rset));
84 }
85 return result;
86 }
87
88 }