Skip to content

Commit 3a974bf

Browse files
committed
Add JavaDoc comments
1 parent b29dde3 commit 3a974bf

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

doma-core/src/main/java/org/seasar/doma/jdbc/Config.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,11 @@ default EntityListenerProvider getEntityListenerProvider() {
226226
return ConfigSupport.defaultEntityListenerProvider;
227227
}
228228

229+
/**
230+
* Returns the context for SQL builder settings.
231+
*
232+
* @return the context for SQL builder settings
233+
*/
229234
default SqlBuilderSettings getSqlBuilderSettings() {
230235
return ConfigSupport.defaultSqlBuilderSettings;
231236
}

doma-core/src/main/java/org/seasar/doma/jdbc/SqlBuilderSettings.java

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,35 @@
11
package org.seasar.doma.jdbc;
22

3+
/** A context for SQL builder settings. */
34
public interface SqlBuilderSettings {
45

6+
/**
7+
* Returns whether the block comment should be removed. The beginning of the {@code comment}
8+
* parameter string must always start with "/*".
9+
*
10+
* @param comment the block comment, never null
11+
* @return true if the block comment should be removed
12+
*/
513
default boolean shouldRemoveBlockComment(String comment) {
614
return false;
715
}
816

17+
/**
18+
* Returns whether the line comment should be removed. The beginning of the {@code comment}
19+
* parameter string must always start with "--".
20+
*
21+
* @param comment the line comment, never null
22+
* @return true if the line comment should be removed
23+
*/
924
default boolean shouldRemoveLineComment(String comment) {
1025
return false;
1126
}
1227

28+
/**
29+
* Returns whether the blank lines should be removed.
30+
*
31+
* @return true if the blank lines should be removed
32+
*/
1333
default boolean shouldRemoveBlankLines() {
1434
return false;
1535
}

0 commit comments

Comments
 (0)