Skip to content

Commit 7552bb7

Browse files
committed
Some javadocs [ci skip]
1 parent 7549f02 commit 7552bb7

File tree

3 files changed

+18
-9
lines changed

3 files changed

+18
-9
lines changed

src/main/java/org/apache/ibatis/mapping/BoundSql.java

+8
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
import org.apache.ibatis.reflection.MetaObject;
2323
import org.apache.ibatis.session.Configuration;
2424

25+
/**
26+
* An actual SQL String got form an {@link SqlSource} after having processed any dynamic content.
27+
* The SQL may have SQL placeholders "?" and an list (ordered) of an parameter mappings
28+
* with the additional information for each parameter (at least the property name of the input object to read
29+
* the value from).
30+
* </br>
31+
* Can also have additional parameters that are created by the dynamic language (for loops, bind...).
32+
*/
2533
public class BoundSql {
2634

2735
private String sql;

src/main/java/org/apache/ibatis/mapping/SqlSource.java

+2-5
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,8 @@
1616
package org.apache.ibatis.mapping;
1717

1818
/**
19-
*
20-
* This bean represets the content of a mapped statement read from an XML file
21-
* or an annotation. It creates the SQL that will be passed to the database out
22-
* of the input parameter received from the user.
23-
*
19+
* Represents the content of a mapped statement read from an XML file or an annotation.
20+
* It creates the SQL that will be passed to the database out of the input parameter received from the user.
2421
*/
2522
public interface SqlSource {
2623

src/main/java/org/apache/ibatis/scripting/LanguageDriver.java

+8-4
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@
2020
import org.apache.ibatis.mapping.MappedStatement;
2121
import org.apache.ibatis.mapping.SqlSource;
2222
import org.apache.ibatis.parsing.XNode;
23+
import org.apache.ibatis.scripting.defaults.DefaultParameterHandler;
2324
import org.apache.ibatis.session.Configuration;
2425

2526
public interface LanguageDriver {
2627

2728
/**
28-
* Creates a {@link ParameterHandler} that will set the parameters of the
29-
*
29+
* Creates a {@link ParameterHandler} that passes the actual parameters to the the JDBC statement.
30+
*
31+
* @see DefaultParameterHandler
3032
* @param mappedStatement The mapped statement that is being executed
3133
* @param parameterObject The input parameter object (can be null)
3234
* @param boundSql The resulting SQL once the dynamic language has been executed.
@@ -35,7 +37,8 @@ public interface LanguageDriver {
3537
ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql);
3638

3739
/**
38-
* Creates an {@link SqlSource} that will hold the statement read from a mapper xml file
40+
* Creates an {@link SqlSource} that will hold the statement read from a mapper xml file.
41+
* It is called during startup, when the mapped statement is read from a class or an xml file.
3942
*
4043
* @param configuration The MyBatis configuration
4144
* @param script XNode parsed from a XML file
@@ -45,7 +48,8 @@ public interface LanguageDriver {
4548
SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType);
4649

4750
/**
48-
* Creates an {@link SqlSource} that will hold the statement read from an annotation
51+
* Creates an {@link SqlSource} that will hold the statement read from an annotation.
52+
* It is called during startup, when the mapped statement is read from a class or an xml file.
4953
*
5054
* @param configuration The MyBatis configuration
5155
* @param script The content of the annotation

0 commit comments

Comments
 (0)