yosql-dao/yosql-dao-jdbc/src/main/java/wtf/metio/yosql/dao/jdbc/JdbcMethods.java

   1 /*
   2  * This file is part of yosql. It is subject to the license terms in the LICENSE file found in the top-level
   3  * directory of this distribution and at https://creativecommons.org/publicdomain/zero/1.0/. No part of yosql,
   4  * including this file, may be copied, modified, propagated, or distributed except according to the terms contained
   5  * in the LICENSE file.
   6  */
   7
   8 package wtf.metio.yosql.dao.jdbc;
   9
  10 import com.squareup.javapoet.CodeBlock;
  11
  12 /**
  13  * Entry point for methods of the JDBC API. Nested interfaces are used to distinguish the source of the methods.
  14  */
  15 public interface JdbcMethods {
  16
  17     JdbcDataSourceMethods dataSource();
  18
  19     JdbcConnectionMethods connection();
  20
  21     JdbcDatabaseMetaDataMethods databaseMetaData();
  22
  23     JdbcResultSetMethods resultSet();
  24     JdbcResultSetMetaDataMethods resultSetMetaData();
  25
  26     JdbcStatementMethods statement();
  27
  28     /**
  29      * Methods that are exposed by a JDBC DataSource object.
  30      *
  31      * @see javax.sql.DataSource
  32      */
  33     interface JdbcDataSourceMethods {
  34         CodeBlock getConnection();
  35     }
  36
  37     /**
  38      * Methods that are exposed by a JDBC Connection object.
  39      *
  40      * @see java.sql.Connection
  41      */
  42     interface JdbcConnectionMethods {
  43         CodeBlock prepareStatement();
  44
  45         CodeBlock prepareCallable();
  46
  47         CodeBlock getMetaData();
  48     }
  49
  50     interface JdbcDatabaseMetaDataMethods {
  51         CodeBlock getDatabaseProductName();
  52     }
  53
  54     /**
  55      * Methods that are exposed by a JDBC ResultSet object.
  56      *
  57      * @see java.sql.ResultSet
  58      */
  59     interface JdbcResultSetMethods {
  60         CodeBlock getMetaData();
  61     }
  62
  63     /**
  64      * Methods that are exposed by a JDBC ResultSetMetaData object.
  65      *
  66      * @see java.sql.ResultSetMetaData
  67      */
  68     interface JdbcResultSetMetaDataMethods {
  69         CodeBlock getColumnCount();
  70     }
  71
  72     /**
  73      * Methods that are exposed by a JDBC Statement object.
  74      *
  75      * @see java.sql.Statement
  76      * @see java.sql.PreparedStatement
  77      */
  78     interface JdbcStatementMethods {
  79         CodeBlock executeQuery();
  80
  81         CodeBlock executeUpdate();
  82
  83         CodeBlock executeBatch();
  84
  85         CodeBlock addBatch();
  86
  87         CodeBlock getResultSet();
  88
  89         CodeBlock execute();
  90     }
  91
  92 }