Add Javadoc

Author: jeanbisutti

Diff for: src/main/java/org/qstd/QuickSqlTestData.java

@@ -51,7 +51,7 @@ private QuickSqlTestData(DatasetRowsGenerator datasetRowsGenerator, DatabaseType
 
     /**
      * Factory method to build an instance of <code>org.qstd.QuickSqlTestData</code> from a data source.
-     * The retrieval of database metadata, such as not null columns or primary keys, is cached for each table.
+     * <em>The retrieval of database metadata, such as not null columns or primary keys, is cached for each table.</em>
      * @param dataSource A data source
      * @return An instance of <code>org.qstd.QuickSqlTestData</code>
      */
@@ -63,37 +63,85 @@ public static QuickSqlTestData buildFrom(DataSource dataSource) {
         return buildFrom(dataSource, dbType, databaseMetadataFinderWithCache);
     }
 
+    /**
+     * Factory method to build an instance of <code>org.qstd.QuickSqlTestData</code> from a data source,
+     * a database type and a database metadata finder.
+     * @param dataSource A datasource
+     * @param dbType A database type
+     * @param databaseMetadataFinder A database metadata finder
+     * @return An instance of <code>org.qstd.QuickSqlTestData</code>
+     */
     public static QuickSqlTestData buildFrom(DataSource dataSource, DatabaseType dbType, DatabaseMetadataFinder databaseMetadataFinder) {
         DatasetRowsGenerator datasetRowsGenerator = new DatasetRowsGenerator(dataSource, dbType, databaseMetadataFinder);
         return new QuickSqlTestData(datasetRowsGenerator, dbType);
     }
 
+    /**
+     * Generates an SQL script allowing to test the SQL query given in parameter.
+     * This script contains INSERT statements.
+     * It takes into account the database integrity constraints.
+     * @param sqlQuery An SQL query
+     * @return An SQL script allowing to test the SQL query given in parameter
+     */
     public String generateInsertScriptFor(String sqlQuery) {
         return generateInsertScriptFor(sqlQuery, emptyList());
     }
 
+    /**
+     * Generates an SQL script allowing to test an SQL query with its bind parameter values.
+     * This script contains INSERT statements.
+     * It takes into account the database integrity constraints.
+     * @param query An SQL query with bind parameters
+     * @param parameters Bind parameter values
+     * @return An SQL script allowing to test the SQL query with  its bind parameter values
+     */
     public String generateInsertScriptFor(String query, List<Object> parameters) {
         List<SqlQuery> sqlQueries = singletonList(new SqlQuery(query, parameters));
         return generateInsertScriptFor(sqlQueries);
     }
 
+    /**
+     * Generates an SQL script allowing to test the list of SQL queries given in parameter.
+     * This script contains INSERT statements.
+     * It takes into account the database integrity constraints.
+     * @param sqlQueries SQL queries
+     * @return An SQL script allowing to test the SQL queries given in parameter
+     */
     public String generateInsertScriptFor(List<SqlQuery> sqlQueries) {
         List<DatasetRow> datasetRows = datasetRowsGenerator.generateDatasetRowsFor(sqlQueries);
         return insertStatementGenerator.generateInsertScriptFor(datasetRows);
     }
 
+    /**
+     * Generates a list of INSERT statements allowing to test the list of SQL queries given in parameter.
+     * These INSERT statements take into account the database integrity constraints.
+     * @param sqlQueries SQL queries
+     * @return An SQL script allowing to test the SQL queries given in parameter
+     */
     public String generateInsertScriptFor(String... sqlQueries) {
         List<SqlQuery> queries = stream(sqlQueries)
                                 .map(SqlQuery::new)
                                 .collect(toList());
         return generateInsertScriptFor(queries);
     }
 
+    /**
+     * Generates a list of INSERT statements allowing to create in database the dataset row given in parameter.
+     * These INSERT statements take into account the database integrity constraints.
+     * @param datasetRow A dataset row
+     * @return A list of INSERT statements allowing to create in database the dataset row given in parameter
+     */
     public List<String> generateInsertListFor(DatasetRow datasetRow) {
         SqlQuery sqlQuery = SqlQuery.buildFromRow(datasetRow, dbType);
         return generateInsertListFor(sqlQuery.toString());
     }
 
+    /**
+     * Generates a list of INSERT statements allowing to test the SQL queries given in parameter.
+     * These INSERT statements take into account the database integrity constraints.
+     * @param sqlQueries SQL queries
+     * @return A list of INSERT statements allowing to test the SQL queries given in parameter
+     */
     public List<String> generateInsertListFor(String... sqlQueries) {
         List<SqlQuery> sqlQueryObjects = stream(sqlQueries)
                                         .map(SqlQuery::new)

Diff for: src/main/java/org/qstd/SqlQuery.java

@@ -18,17 +18,29 @@
 
 import static java.util.stream.Collectors.joining;
 
+/**
+ * Class to represent an SQL query
+ */
 public class SqlQuery {
 
     private final String queryAsString;
 
     private final List<Object> parameters;
 
+    /**
+     * Constructor to instantiate an SQL Query from an SQL query as String
+     * @param queryAsString An SQL query as string
+     */
     public SqlQuery(String queryAsString) {
         this.queryAsString = queryAsString;
         this.parameters = Collections.emptyList();
     }
 
+    /**
+     * Constructor to instantiate an SQL query from an SQL query with bind parameters and its bind parameter values
+     * @param queryAsString An SQL query as String with bind parameters
+     * @param parameters Bind parameter values
+     */
     public SqlQuery(String queryAsString, List<Object> parameters) {
         this.queryAsString = queryAsString;
         this.parameters = parameters;