root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Improve Javadoc in SQL script support classes

This commit is contained in:
Sam Brannen 2014-04-13 12:31:07 +02:00
parent 910dd41467
commit 8fecee8c8a
2 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
spring-jdbc/src/main/java/org/springframework/jdbc/datasource/init/ResourceDatabasePopulator.java
View File

@ -48,6 +48,7 @@ import org.springframework.core.io.support.EncodedResource;
* @author Chris Baldwin * @author Chris Baldwin
* @since 3.0 * @since 3.0
* @see DatabasePopulatorUtils * @see DatabasePopulatorUtils
* @see ScriptUtils
*/ */
public class ResourceDatabasePopulator implements DatabasePopulator { public class ResourceDatabasePopulator implements DatabasePopulator {
@ -195,10 +196,10 @@ public class ResourceDatabasePopulator implements DatabasePopulator {
/** /**
* Flag to indicate that a failed SQL {@code DROP} statement can be ignored. * Flag to indicate that a failed SQL {@code DROP} statement can be ignored.
* <p>This is useful for non-embedded databases whose SQL dialect does not support an * <p>This is useful for a non-embedded database whose SQL dialect does not
* {@code IF EXISTS} clause in a {@code DROP} statement. * support an {@code IF EXISTS} clause in a {@code DROP} statement.
* <p>The default is {@code false} so that if the populator runs accidentally, it will * <p>The default is {@code false} so that if the populator runs accidentally, it will
* fail fast if the script starts with a {@code DROP} statement. * fail fast if a script starts with a {@code DROP} statement.
* @param ignoreFailedDrops {@code true} if failed drop statements should be ignored * @param ignoreFailedDrops {@code true} if failed drop statements should be ignored
*/ */
public void setIgnoreFailedDrops(boolean ignoreFailedDrops) { public void setIgnoreFailedDrops(boolean ignoreFailedDrops) {
@ -219,7 +220,8 @@ public class ResourceDatabasePopulator implements DatabasePopulator {
} }
/** /**
* Execute this {@code DatabasePopulator} against the given {@link DataSource}. * Execute this {@code ResourceDatabasePopulator} against the given
* {@link DataSource}.
* <p>Delegates to {@link DatabasePopulatorUtils#execute}. * <p>Delegates to {@link DatabasePopulatorUtils#execute}.
* @param dataSource the {@code DataSource} to execute against * @param dataSource the {@code DataSource} to execute against
* @throws ScriptException if an error occurs * @throws ScriptException if an error occurs
@ -231,8 +233,10 @@ public class ResourceDatabasePopulator implements DatabasePopulator {
} }
/** /**
* {@link EncodedResource} is not a sub-type of {@link Resource}. Thus we always need * {@link EncodedResource} is not a sub-type of {@link Resource}. Thus we
* to wrap each script resource in an encoded resource. * always need to wrap each script resource in an {@code EncodedResource}
* using the configured {@linkplain #setSqlScriptEncoding encoding}.
* @param script the script to wrap
*/ */
private EncodedResource encodeScript(Resource script) { private EncodedResource encodeScript(Resource script) {
return new EncodedResource(script, this.sqlScriptEncoding); return new EncodedResource(script, this.sqlScriptEncoding);

30
spring-jdbc/src/main/java/org/springframework/jdbc/datasource/init/ScriptUtils.java
View File

@ -50,19 +50,19 @@ public abstract class ScriptUtils {
private static final Log logger = LogFactory.getLog(ScriptUtils.class); private static final Log logger = LogFactory.getLog(ScriptUtils.class);
/** /**
* Default statement separator within SQL scripts. * Default statement separator within SQL scripts: {@code ";"}.
*/ */
public static final String DEFAULT_STATEMENT_SEPARATOR = ";"; public static final String DEFAULT_STATEMENT_SEPARATOR = ";";
/** /**
* Fallback statement separator within SQL scripts. * Fallback statement separator within SQL scripts: {@code "\n"}.
* <p>Used if neither a custom defined separator nor the * <p>Used if neither a custom separator nor the
* {@link #DEFAULT_STATEMENT_SEPARATOR} is present in a given script. * {@link #DEFAULT_STATEMENT_SEPARATOR} is present in a given script.
*/ */
public static final String FALLBACK_STATEMENT_SEPARATOR = "\n"; public static final String FALLBACK_STATEMENT_SEPARATOR = "\n";
/** /**
* End of file (EOF) SQL statement separator. * End of file (EOF) SQL statement separator: {@code "^^^ END OF SCRIPT ^^^"}.
* <p>This value may be supplied as the {@code separator} to {@link * <p>This value may be supplied as the {@code separator} to {@link
* #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)} * #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)}
* to denote that an SQL script contains a single statement (potentially * to denote that an SQL script contains a single statement (potentially
@ -73,17 +73,17 @@ public abstract class ScriptUtils {
public static final String EOF_STATEMENT_SEPARATOR = "^^^ END OF SCRIPT ^^^"; public static final String EOF_STATEMENT_SEPARATOR = "^^^ END OF SCRIPT ^^^";
/** /**
* Default prefix for line comments within SQL scripts. * Default prefix for single-line comments within SQL scripts: {@code "--"}.
*/ */
public static final String DEFAULT_COMMENT_PREFIX = "--"; public static final String DEFAULT_COMMENT_PREFIX = "--";
/** /**
* Default start delimiter for block comments within SQL scripts. * Default start delimiter for block comments within SQL scripts: {@code "/*"}.
*/ */
public static final String DEFAULT_BLOCK_COMMENT_START_DELIMITER = "/*"; public static final String DEFAULT_BLOCK_COMMENT_START_DELIMITER = "/*";
/** /**
* Default end delimiter for block comments within SQL scripts. * Default end delimiter for block comments within SQL scripts: <code>"*&#47;"</code>.
*/ */
public static final String DEFAULT_BLOCK_COMMENT_END_DELIMITER = "*/"; public static final String DEFAULT_BLOCK_COMMENT_END_DELIMITER = "*/";
@ -351,8 +351,8 @@ public abstract class ScriptUtils {
} }
/** /**
* Execute the given SQL script using default settings for separator separators, * Execute the given SQL script using default settings for statement
* comment delimiters, and exception handling flags. * separators, comment delimiters, and exception handling flags.
* <p>Statement separators and comments will be removed before executing * <p>Statement separators and comments will be removed before executing
* individual statements within the supplied script. * individual statements within the supplied script.
* <p><b>Do not use this method to execute DDL if you expect rollback.</b> * <p><b>Do not use this method to execute DDL if you expect rollback.</b>
@ -362,8 +362,8 @@ public abstract class ScriptUtils {
* current platform's default encoding * current platform's default encoding
* @throws ScriptException if an error occurred while executing the SQL script * @throws ScriptException if an error occurred while executing the SQL script
* @see #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String) * @see #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)
* @see #DEFAULT_COMMENT_PREFIX
* @see #DEFAULT_STATEMENT_SEPARATOR * @see #DEFAULT_STATEMENT_SEPARATOR
* @see #DEFAULT_COMMENT_PREFIX
* @see #DEFAULT_BLOCK_COMMENT_START_DELIMITER * @see #DEFAULT_BLOCK_COMMENT_START_DELIMITER
* @see #DEFAULT_BLOCK_COMMENT_END_DELIMITER * @see #DEFAULT_BLOCK_COMMENT_END_DELIMITER
*/ */
@ -372,8 +372,8 @@ public abstract class ScriptUtils {
} }
/** /**
* Execute the given SQL script using default settings for separator separators, * Execute the given SQL script using default settings for statement
* comment delimiters, and exception handling flags. * separators, comment delimiters, and exception handling flags.
* <p>Statement separators and comments will be removed before executing * <p>Statement separators and comments will be removed before executing
* individual statements within the supplied script. * individual statements within the supplied script.
* <p><b>Do not use this method to execute DDL if you expect rollback.</b> * <p><b>Do not use this method to execute DDL if you expect rollback.</b>
@ -383,8 +383,8 @@ public abstract class ScriptUtils {
* to load the SQL script from * to load the SQL script from
* @throws ScriptException if an error occurred while executing the SQL script * @throws ScriptException if an error occurred while executing the SQL script
* @see #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String) * @see #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)
* @see #DEFAULT_COMMENT_PREFIX
* @see #DEFAULT_STATEMENT_SEPARATOR * @see #DEFAULT_STATEMENT_SEPARATOR
* @see #DEFAULT_COMMENT_PREFIX
* @see #DEFAULT_BLOCK_COMMENT_START_DELIMITER * @see #DEFAULT_BLOCK_COMMENT_START_DELIMITER
* @see #DEFAULT_BLOCK_COMMENT_END_DELIMITER * @see #DEFAULT_BLOCK_COMMENT_END_DELIMITER
*/ */
@ -406,8 +406,8 @@ public abstract class ScriptUtils {
* in the event of an error * in the event of an error
* @param ignoreFailedDrops whether or not to continue in the event of specifically * @param ignoreFailedDrops whether or not to continue in the event of specifically
* an error on a {@code DROP} statement * an error on a {@code DROP} statement
* @param commentPrefix the prefix that identifies comments in the SQL script &mdash; * @param commentPrefix the prefix that identifies single-line comments in the
* typically "--" * SQL script &mdash; typically "--"
* @param separator the script statement separator; defaults to * @param separator the script statement separator; defaults to
* {@value #DEFAULT_STATEMENT_SEPARATOR} if not specified and falls back to * {@value #DEFAULT_STATEMENT_SEPARATOR} if not specified and falls back to
* {@value #FALLBACK_STATEMENT_SEPARATOR} as a last resort; may be set to * {@value #FALLBACK_STATEMENT_SEPARATOR} as a last resort; may be set to