Code documentation added

Author: Denzel Code

src/main/java/advancedsql/ISQL.java

@@ -11,14 +11,38 @@
 
 public interface ISQL {
 
+    /**
+     * Prepare SQL query.
+     * @param query Query object that you want to prepare.
+     * @return A PreparedStatement object.
+     * @throws SQLException Exception when something goes wrong.
+     */
     PreparedStatement prepare(IQuery query) throws SQLException;
 
+    /**
+     * Get access to a table object to modify information.
+     * @param name Name of the table.
+     * @return A Table object which allows you to execute SQL query's.
+     */
     ITable table(String name);
 
+    /**
+     * Get connection state.
+     * @return true if connected, false if not.
+     */
     boolean isConnected();
 
+    /**
+     * @return Connection Object.
+     */
     Connection getConnection();
 
+    /**
+     * Convert a ResultSet into a list.
+     * @param resultSet Result set
+     * @return Returns a list of map with the column name and value.
+     * @throws SQLException Exception when something goes wrong.
+     */
     static List<Map<String, Object>> convertResultSetToList(ResultSet resultSet) throws SQLException {
         ResultSetMetaData metaData = resultSet.getMetaData();
 
@@ -37,6 +61,12 @@ static List<Map<String, Object>> convertResultSetToList(ResultSet resultSet) thr
         return list;
     }
 
+    /**
+     * Set statement parameters.
+     * @param statement Statement to modify.
+     * @param execute Parameters to assign.
+     * @throws SQLException Exception when something goes wrong.
+     */
     static void setStatementParameters(PreparedStatement statement, List<Object> execute) throws SQLException {
         for (int i = 0; i < execute.size(); i++) {
             Object value = execute.get(i);

src/main/java/advancedsql/MySQL.java

@@ -8,6 +8,16 @@
 
 public class MySQL extends SQL {
 
+    /**
+     * Create MySQL connection.
+     * Do not worry about creating the database, AdvancedSQL takes care of it for you.
+     * @param host MySQL server host.
+     * @param port MySQL server port.
+     * @param username MySQL server username.
+     * @param password MySQL server password.
+     * @param database MySQL server database. If not exists AdvancedSQL creates it for you.
+     * @throws SQLException Exception when something goes wrong.
+     */
     public MySQL(String host, int port, String username, String password, String database) throws SQLException {
         try {
             Class.forName("com.mysql.cj.jdbc.Driver");

src/main/java/advancedsql/query/Alter.java

@@ -16,14 +16,23 @@ public Alter(ITable table) {
         super(table);
     }
 
+    /**
+     * @return "Drop" Object that allows you to specify the columns that you want to drop.
+     */
     public advancedsql.query.action.Drop drop() {
         return drop;
     }
 
+    /**
+     * @return "Modify" Object that allows you to specify the columns that you want to modify.
+     */
     public advancedsql.query.action.Modify modify() {
         return modify;
     }
 
+    /**
+     * @return "Add" Object that allows you to specify the columns that you want to add.
+     */
     public advancedsql.query.action.Add add() {
         return add;
     }

src/main/java/advancedsql/query/ExecuteQuery.java

@@ -24,6 +24,10 @@ public PreparedStatement executePrepare() throws SQLException {
         return this.prepare;
     }
 
+    /**
+     * @return A Map of the first result found.
+     * @throws SQLException Exception when something goes wrong.
+     */
     public Map<String, Object> fetch() throws SQLException {
         this.limit(1);
 
@@ -48,16 +52,29 @@ public Map<String, Object> fetch() throws SQLException {
         return map;
     }
 
+    /**
+     * @return ResultSet of all the results found.
+     * @throws SQLException Exception when something goes wrong.
+     */
     public ResultSet fetchAll() throws SQLException {
         return execute();
     }
 
+    /**
+     * @return A List of all the results found.
+     * @throws SQLException Exception when something goes wrong.
+     */
     public List<Map<String, Object>> fetchAllAsList() throws SQLException {
         ResultSet resultSet = this.fetchAll();
 
         return ISQL.convertResultSetToList(resultSet);
     }
 
+    /**
+     * Execute query.
+     * @return A ResultSet of all the results found.
+     * @throws SQLException Exception when something goes wrong.
+     */
     public ResultSet execute() throws SQLException {
         return this.executeQuery();
     }

src/main/java/advancedsql/query/ExecuteStatement.java

@@ -18,6 +18,11 @@ public PreparedStatement executePrepare() throws SQLException {
         return this.prepare;
     }
 
+    /**
+     * Execute query.
+     * @return A boolean.
+     * @throws SQLException Exception when something goes wrong.
+     */
     public Boolean execute() throws SQLException {
         return this.executeStatement();
     }

src/main/java/advancedsql/query/ExecuteUpdate.java

@@ -20,6 +20,11 @@ public PreparedStatement executePrepare() throws SQLException {
         return this.prepare;
     }
 
+    /**
+     * Execute the query.
+     * @return An integer.
+     * @throws SQLException Exception when something goes wrong.
+     */
     public int execute() throws SQLException {
         return this.executeUpdate();
     }

src/main/java/advancedsql/query/IQuery.java

@@ -6,17 +6,69 @@
 
 public interface IQuery {
 
+    /**
+     * Specify what values will be affected for example:
+     * query.where("first_name = ? AND last_name = ?", "Denzel", "Code");
+     * @param where Where statement.
+     * @param execute Values of the statement.
+     * @return Query object.
+     */
     IQuery where(String where, Object... execute);
 
+    /**
+     * Specify what values will be affected for example:
+     * query.where("first_name = 'Denzel' AND last_name = 'Code'");
+     * @param where Where statement.
+     * @return Query object.
+     */
     IQuery where(String where);
 
+    /**
+     * Execute query and return a boolean.
+     * Recommended for: CREATE, ALTER, DROP, TRUNCATE.
+     * @return boolean.
+     * @throws SQLException Exception when something goes wrong.
+     */
     Boolean executeStatement() throws SQLException;
 
+    /**
+     * Execute query and return an integer.
+     * Recommended for: INSERT, UPDATE, DELETE.
+     * @return integer.
+     * @throws SQLException Exception when something goes wrong.
+     */
     int executeUpdate() throws SQLException;
 
+    /**
+     * Execute query and return a ResultSet.
+     * Recommended for: SELECT, SHOW.
+     * @return ResultSet.
+     * @throws SQLException Exception when something goes wrong.
+     */
     ResultSet executeQuery() throws SQLException;
 
+    /**
+     * Execute query and return a PreparedStatement.
+     * Recommended for: General.
+     * @return PreparedStatement.
+     * @throws SQLException Exception when something goes wrong.
+     */
     PreparedStatement executePrepare() throws SQLException;
 
+    /**
+     * Get PreparedStatement of the query.
+     * This just works if you already executed the query.
+     * @return PreparedStatement.
+     */
+    PreparedStatement getPrepare();
+
+    /**
+     * @return String representation of the Query.
+     */
     String toQuery();
+
+    /**
+     * @return String representation of the Query.
+     */
+    String toString();
 }

src/main/java/advancedsql/query/Insert.java

@@ -20,10 +20,16 @@ public Insert(ITable table) {
     public Insert(ITable table, Map<String, Object> fields) {
         super(table);
 
-        this.setFields(fields);
+        this.fields(fields);
     }
 
-    public Insert setField(String field, Object value) {
+    /**
+     * Columns and values that you want to insert.
+     * @param field Column name
+     * @param value Row value
+     * @return Query object.
+     */
+    public Insert field(String field, Object value) {
         this.fields.add(field);
 
         this.values.add(value);
@@ -33,20 +39,17 @@ public Insert setField(String field, Object value) {
         return this;
     }
 
-    public Insert field(String field, Object value) {
-        return this.setField(field, value);
-    }
-
-    public Insert setFields(Map<String, Object> values) {
-        for (Map.Entry<String, Object> entry: values.entrySet()) this.setField(entry.getKey(), entry.getValue());
+    /**
+     * Columns and values that you want to insert.
+     * @param values Map
+     * @return Query object.
+     */
+    public Insert fields(Map<String, Object> values) {
+        for (Map.Entry<String, Object> entry: values.entrySet()) this.field(entry.getKey(), entry.getValue());
 
         return this;
     }
 
-    public Insert fields(Map<String, Object> values) {
-        return this.setFields(values);
-    }
-
     @Override
     public String toQuery() {
         StringBuilder query = new StringBuilder("INSERT INTO " + this.table + " (");

src/main/java/advancedsql/query/Query.java

@@ -32,16 +32,20 @@ public Query(ITable table) {
         this.table = table.getName();
     }
 
-    public T setLimit(int limit) {
+    /**
+     * Assign the limit of rows to be affected.
+     * @param limit Limit amount.
+     * @return Query object.
+     */
+    public T limit(int limit) {
         this.limit = limit;
 
         return (T)this;
     }
 
-    public T limit(int limit) {
-        return this.setLimit(limit);
-    }
-
+    /**
+     * @return Limit of rows to be affected.
+     */
     public int getLimit() {
         return this.limit;
     }