com.jcabi.jdbc.Outcome Maven / Gradle / Ivy
/*
* 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;
/**
* Outcome of ResultSet.
*
* The following convenience implementations are provided:
*
*
* - {@link Outcome#NOT_EMPTY} to check that at least one result row is
* returned.
*
- {@link Outcome#VOID} for when you wish to disregard the result.
*
- {@link Outcome#UPDATE_COUNT} to check the number of updated rows.
*
*
* @param Type of expected result
* @since 0.12
*/
public interface Outcome {
/**
* Returns {@code TRUE} if at least one SQL record found in
* {@link ResultSet}.
*
* The outcome returns the value of {@link ResultSet#next()} and throws
* {@link SQLException} in case of a problem.
*
* @since 0.12
*/
Outcome NOT_EMPTY = (rset, stmt) -> rset.next();
/**
* Outcome that does nothing (and always returns {@code null}).
*
* Useful when you're not interested in the result:
*
*
new JdbcSession(source)
* .sql("INSERT INTO foo (name) VALUES (?)")
* .set("Jeff Lebowski")
* .insert(Outcome.VOID);
*
* @since 0.12
*/
Outcome VOID = (rset, stmt) -> Void.TYPE.cast(null);
/**
* Outcome that returns the number of updated rows.
*
* Use it when you need to determine the number of rows updated:
*
*
Integer count = new JdbcSession(source)
* .sql("UPDATE employee SET salary = 35000 WHERE department = ?")
* .set("Finance")
* .update(Outcome.UPDATE_COUNT);
*
* @since 0.12
*/
Outcome UPDATE_COUNT = (rset, stmt) -> stmt.getUpdateCount();
/**
* Outcome that returns last insert ID.
*
* Use it when you need to get last insert ID from INSERT:
*
*
long id = new JdbcSession(source)
* .sql("INSERT INTO employee (name) VALUES (?)")
* .set("Jeffrey")
* .insert(Outcome.LAST_INSERT_ID);
*
* @since 0.13
*/
Outcome LAST_INSERT_ID = (rset, stmt) -> {
if (!rset.next()) {
throw new SQLException("no last_insert_id() available");
}
return rset.getLong(1);
};
/**
* Default mappings.
*
* @since 0.17.6
*/
Mappings DEFAULT_MAPPINGS = new DefaultMappings();
/**
* Process the result set and return some value.
*
* @param rset The result set to process
* @param stmt The statement used in the run
* @return The result
* @throws SQLException If something goes wrong inside
*/
T handle(ResultSet rset, Statement stmt) throws SQLException;
/**
* Mapping.
*
* @param Type of output
* @since 0.13
*/
interface Mapping {
/**
* Map.
*
* @param rset Result set
* @return Object
* @throws SQLException If fails
*/
T map(ResultSet rset) throws SQLException;
}
/**
* Mappings for different types.
*
* @since 0.17.6
*/
interface Mappings {
/**
* Mapping for a type.
*
* @param tpe Class of result.
* @param Type of result.
* @return Mapping.
*/
Mapping forType(Class tpe);
}
}