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.Collection;
36 import java.util.Date;
37 import java.util.LinkedList;
38 import java.util.UUID;
39 import lombok.EqualsAndHashCode;
40 import lombok.RequiredArgsConstructor;
41 import lombok.ToString;
42
43 /**
44 * Outcome that returns first column.
45 *
46 * <p>Use it when you need the first column:
47 *
48 * <pre> Collection&lgt;Long> salaries = new JdbcSession(source)
49 * .sql("SELECT salary FROM user")
50 * .select(new ColumnOutcome<Long>(Long.class));</pre>
51 *
52 * <p>Supported types are: {@link String}, {@link Long}, {@link Boolean},
53 * {@link Byte}, {@link Date}, {@link UUID}, and {@link Utc}.
54 *
55 * @param <T> Type of items
56 * @since 0.13
57 */
58 @ToString
59 @EqualsAndHashCode
60 @RequiredArgsConstructor
61 public final class ColumnOutcome<T> implements Outcome<Collection<T>> {
62
63 /**
64 * Mapping.
65 */
66 private final Mapping<T> mapping;
67
68 /**
69 * Public ctor.
70 *
71 * @param tpe The type to convert to
72 */
73 public ColumnOutcome(final Class<T> tpe) {
74 this(tpe, Outcome.DEFAULT_MAPPINGS);
75 }
76
77 /**
78 * Public ctor.
79 *
80 * @param tpe The type to convert to
81 * @param mps The mappings.
82 */
83 public ColumnOutcome(final Class<T> tpe, final Mappings mps) {
84 this(mps.forType(tpe));
85 }
86
87 @Override
88 public Collection<T> handle(final ResultSet rset, final Statement stmt)
89 throws SQLException {
90 final Collection<T> result = new LinkedList<>();
91 while (rset.next()) {
92 result.add(this.mapping.map(rset));
93 }
94 return result;
95 }
96
97 }