Skip to content

Commit 9430555

Browse files
committed
fix up javadoc for SqlScriptCommandExtractor and friends
1 parent cb6b019 commit 9430555

File tree

4 files changed

+24
-10
lines changed

4 files changed

+24
-10
lines changed

hibernate-core/src/main/java/org/hibernate/cfg/SchemaToolingSettings.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,14 +216,15 @@ public interface SchemaToolingSettings {
216216
* <p>
217217
* The correct extractor to use depends on the format of the SQL script:
218218
* <ul>
219-
* <li>if the script has one complete SQL statement per line, use
219+
* <li>if the script has one complete SQL statement per line, use {@code single-line} or
220220
* {@link org.hibernate.tool.schema.internal.script.SingleLineSqlScriptExtractor}, or
221-
* <li>if a script contains statements spread over multiple lines, use
221+
* <li>if a script contains statements spread over multiple lines, use {@code multi-line} or
222222
* {@link org.hibernate.tool.schema.internal.script.MultiLineSqlScriptExtractor}.
223223
* </ul>
224224
*
225225
* @settingDefault {@code org.hibernate.tool.schema.internal.script.SingleLineSqlScriptExtractor}.
226226
*
227+
* @see org.hibernate.tool.schema.spi.SqlScriptCommandExtractor
227228
* @see org.hibernate.tool.schema.internal.script.SingleLineSqlScriptExtractor
228229
* @see org.hibernate.tool.schema.internal.script.MultiLineSqlScriptExtractor
229230
*/

hibernate-core/src/main/java/org/hibernate/tool/schema/internal/script/MultiLineSqlScriptExtractor.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,14 @@
2626
import org.antlr.v4.runtime.misc.ParseCancellationException;
2727

2828
/**
29-
* Class responsible for extracting SQL statements from import script. Supports instructions/comments and quoted
30-
* strings spread over multiple lines. Each statement must end with semicolon.
29+
* Class responsible for extracting SQL statements from an import script.
30+
* Supports instructions/comments and quoted strings spread over multiple lines.
31+
* Each statement must end with a semicolon.
3132
*
3233
* @author Lukasz Antoniak
3334
* @author Steve Ebersole
35+
*
36+
* @see org.hibernate.cfg.SchemaToolingSettings#HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR
3437
*/
3538
public class MultiLineSqlScriptExtractor implements SqlScriptCommandExtractor {
3639
public static final String SHORT_NAME = "multi-line";

hibernate-core/src/main/java/org/hibernate/tool/schema/internal/script/SingleLineSqlScriptExtractor.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,14 @@
1515
import org.hibernate.tool.schema.spi.SqlScriptException;
1616

1717
/**
18-
* Class responsible for extracting SQL statements from import script. Treats each line as a complete SQL statement.
19-
* Comment lines shall start with {@code --}, {@code //} or {@code /*} character sequence.
18+
* Class responsible for extracting SQL statements from an import script.
19+
* Treats each line as a complete SQL statement.
20+
* Comment lines must start with {@code --}, {@code //}, or {@code /*}.
2021
*
2122
* @author Lukasz Antoniak
2223
* @author Steve Ebersole
24+
*
25+
* @see org.hibernate.cfg.SchemaToolingSettings#HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR
2326
*/
2427
public class SingleLineSqlScriptExtractor implements SqlScriptCommandExtractor {
2528
public static final String SHORT_NAME = "single-line";

hibernate-core/src/main/java/org/hibernate/tool/schema/spi/SqlScriptCommandExtractor.java

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,20 @@
1212

1313
/**
1414
* Contract for extracting statements from source/import/init scripts.
15+
* <p>
16+
* A concrete implementation may be selected via
17+
* {@value org.hibernate.cfg.SchemaToolingSettings#HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR}.
1518
*
1619
* @author Lukasz Antoniak
1720
*
18-
* @see org.hibernate.cfg.AvailableSettings#HBM2DDL_IMPORT_FILES
19-
* @see org.hibernate.cfg.AvailableSettings#JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE
20-
* @see org.hibernate.cfg.AvailableSettings#JAKARTA_HBM2DDL_CREATE_SCRIPT_SOURCE
21-
* @see org.hibernate.cfg.AvailableSettings#JAKARTA_HBM2DDL_DROP_SCRIPT_SOURCE
21+
* @see org.hibernate.cfg.SchemaToolingSettings#HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR
22+
* @see org.hibernate.tool.schema.internal.script.SingleLineSqlScriptExtractor
23+
* @see org.hibernate.tool.schema.internal.script.MultiLineSqlScriptExtractor
24+
*
25+
* @see org.hibernate.cfg.SchemaToolingSettings#HBM2DDL_IMPORT_FILES
26+
* @see org.hibernate.cfg.SchemaToolingSettings#JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE
27+
* @see org.hibernate.cfg.SchemaToolingSettings#JAKARTA_HBM2DDL_CREATE_SCRIPT_SOURCE
28+
* @see org.hibernate.cfg.SchemaToolingSettings#JAKARTA_HBM2DDL_DROP_SCRIPT_SOURCE
2229
*/
2330
public interface SqlScriptCommandExtractor extends Service {
2431
/**

0 commit comments

Comments
 (0)