Skip to content

Commit 2b68c93

Browse files
committed
Better Property Name
1 parent bc814e7 commit 2b68c93

File tree

16 files changed

+100
-101
lines changed

16 files changed

+100
-101
lines changed

src/main/java/org/mybatis/dynamic/sql/configuration/GlobalConfiguration.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
// TODO - read initial value from a properties file!
2323
public class GlobalConfiguration {
24-
private static boolean unrenderableWhereClauseAllowed = false;
24+
private static boolean isNonRenderingWhereClauseAllowed = false;
2525

2626
private GlobalConfiguration() {}
2727

@@ -31,17 +31,17 @@ private GlobalConfiguration() {}
3131
if (is != null) {
3232
Properties p = new Properties();
3333
p.load(is);
34-
String value = p.getProperty("unrenderableWhereClauseAllowed");
34+
String value = p.getProperty("nonRenderingWhereClauseAllowed");
3535
if (value != null) {
36-
unrenderableWhereClauseAllowed = Boolean.parseBoolean(value);
36+
isNonRenderingWhereClauseAllowed = Boolean.parseBoolean(value);
3737
}
3838
}
3939
} catch (IOException e) {
4040
// ignore
4141
}
4242
}
4343

44-
public static boolean getUnrenderableWhereClauseAllowed() {
45-
return unrenderableWhereClauseAllowed;
44+
public static boolean isIsNonRenderingWhereClauseAllowed() {
45+
return isNonRenderingWhereClauseAllowed;
4646
}
4747
}

src/main/java/org/mybatis/dynamic/sql/configuration/StatementConfiguration.java

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*/
1616
package org.mybatis.dynamic.sql.configuration;
1717

18-
import org.mybatis.dynamic.sql.exception.UnrenderableWhereClauseException;
18+
import org.mybatis.dynamic.sql.exception.NonRenderingWhereClauseException;
1919

2020
/**
2121
* This class can be used to change some behaviors of the framework. Every configurable statement
@@ -25,9 +25,8 @@
2525
* Configurable behaviors are detailed below:
2626
*
2727
* <dl>
28-
* <dt>unrenderableWhereClauseAllowed</dt>
29-
* <dd>If false (default), the framework will throw an
30-
* {@link UnrenderableWhereClauseException}
28+
* <dt>nonRenderingWhereClauseAllowed</dt>
29+
* <dd>If false (default), the framework will throw a {@link NonRenderingWhereClauseException}
3130
* if a where clause is specified in the statement, but it fails to render because all
3231
* optional conditions do not render. For example, if an "in" condition specifies an
3332
* empty list of values. If no criteria are specified in a where clause, the framework
@@ -40,13 +39,13 @@
4039
* @author Jeff Butler
4140
*/
4241
public class StatementConfiguration {
43-
private boolean unrenderableWhereClauseAllowed = GlobalConfiguration.getUnrenderableWhereClauseAllowed();
42+
private boolean isNonRenderingWhereClauseAllowed = GlobalConfiguration.isIsNonRenderingWhereClauseAllowed();
4443

45-
public boolean getUnrenderableWhereClauseAllowed() {
46-
return unrenderableWhereClauseAllowed;
44+
public boolean isNonRenderingWhereClauseAllowed() {
45+
return isNonRenderingWhereClauseAllowed;
4746
}
4847

49-
public void setUnrenderableWhereClauseAllowed(boolean unrenderableWhereClauseAllowed) {
50-
this.unrenderableWhereClauseAllowed = unrenderableWhereClauseAllowed;
48+
public void setNonRenderingWhereClauseAllowed(boolean nonRenderingWhereClauseAllowed) {
49+
this.isNonRenderingWhereClauseAllowed = nonRenderingWhereClauseAllowed;
5150
}
5251
}

src/main/java/org/mybatis/dynamic/sql/exception/UnrenderableWhereClauseException.java renamed to src/main/java/org/mybatis/dynamic/sql/exception/NonRenderingWhereClauseException.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@
2828
* it could cause all rows in a table to be affected by a statement - for example,
2929
* all rows could be deleted.
3030
*
31-
* <p>If you intend to allow an unrenderable where clause, then configure the
31+
* <p>If you intend to allow a where clause to not render, then configure the
3232
* statement to allow it, or change the global configuration.
3333
*
3434
* @see GlobalConfiguration
3535
* @see StatementConfiguration
3636
* @since 1.4.1
3737
* @author Jeff Butler
3838
*/
39-
public class UnrenderableWhereClauseException extends RuntimeException {
40-
public UnrenderableWhereClauseException() {}
39+
public class NonRenderingWhereClauseException extends RuntimeException {
40+
public NonRenderingWhereClauseException() {}
4141
}

src/main/java/org/mybatis/dynamic/sql/where/WhereModel.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public List<AndOrCriteriaGroup> subCriteria() {
5555
}
5656

5757
public boolean isUnrenderableClauseAllowed() {
58-
return statementConfiguration.getUnrenderableWhereClauseAllowed();
58+
return statementConfiguration.isNonRenderingWhereClauseAllowed();
5959
}
6060

6161
/**

src/main/java/org/mybatis/dynamic/sql/where/render/WhereRenderer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import java.util.stream.Collectors;
2222

2323
import org.mybatis.dynamic.sql.SqlCriterion;
24-
import org.mybatis.dynamic.sql.exception.UnrenderableWhereClauseException;
24+
import org.mybatis.dynamic.sql.exception.NonRenderingWhereClauseException;
2525
import org.mybatis.dynamic.sql.render.RenderingStrategy;
2626
import org.mybatis.dynamic.sql.render.TableAliasCalculator;
2727
import org.mybatis.dynamic.sql.util.FragmentCollector;
@@ -53,7 +53,7 @@ public Optional<WhereClauseProvider> render() {
5353
if (whereClause.isPresent() || whereModel.isUnrenderableClauseAllowed()) {
5454
return whereClause;
5555
} else {
56-
throw new UnrenderableWhereClauseException();
56+
throw new NonRenderingWhereClauseException();
5757
}
5858
}
5959

src/test/java/examples/animal/data/AnimalDataTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,7 @@ void testInConditionWithEventuallyEmptyList() {
651651
SelectStatementProvider selectStatement = select(id, animalName, bodyWeight, brainWeight)
652652
.from(animalData)
653653
.where(id, isIn(null, 22, null).filter(Objects::nonNull).filter(i -> i != 22))
654-
.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true))
654+
.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true))
655655
.build()
656656
.render(RenderingStrategies.MYBATIS3);
657657

@@ -767,7 +767,7 @@ void testNotInConditionWithEventuallyEmptyList() {
767767
SelectStatementProvider selectStatement = select(id, animalName, bodyWeight, brainWeight)
768768
.from(animalData)
769769
.where(id, isNotIn(null, 22, null).filter(Objects::nonNull).filter(i -> i != 22))
770-
.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true))
770+
.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true))
771771
.build()
772772
.render(RenderingStrategies.MYBATIS3);
773773

src/test/java/examples/animal/data/OptionalConditionsAnimalDataTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ void testAllIgnored() {
7373
.from(animalData)
7474
.where(id, isGreaterThanWhenPresent(NULL_INTEGER)) // the where clause should not render
7575
.orderBy(id)
76-
.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true))
76+
.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true))
7777
.build()
7878
.render(RenderingStrategies.MYBATIS3);
7979
List<AnimalData> animals = mapper.selectMany(selectStatement);

src/test/java/examples/animal/data/OptionalConditionsWithPredicatesAnimalDataTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ void testAllIgnored() {
7979
.from(animalData)
8080
.where(id, isGreaterThan(NULL_INTEGER).filter(Objects::nonNull)) // the where clause should not render
8181
.orderBy(id)
82-
.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true))
82+
.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true))
8383
.build()
8484
.render(RenderingStrategies.MYBATIS3);
8585
List<AnimalData> animals = mapper.selectMany(selectStatement);

src/test/java/examples/complexquery/ComplexQueryTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ SelectStatementProvider search(Integer targetId, String fName, String lName) {
111111
QueryExpressionDSL<SelectModel>.QueryExpressionWhereBuilder builder = select(id, firstName, lastName)
112112
.from(person)
113113
.where()
114-
.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true));
114+
.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true));
115115

116116
if (targetId != null) {
117117
builder

src/test/java/examples/emptywhere/EmptyWhereTest.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ void testDeleteVariations(Variation variation) {
119119

120120
builder.and(firstName, isEqualTo(variation.firstName).filter(Objects::nonNull));
121121
builder.or(PersonDynamicSqlSupport.lastName, isEqualTo(variation.lastName).filter(Objects::nonNull));
122-
builder.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true));
122+
builder.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true));
123123

124124
DeleteStatementProvider deleteStatement = builder.build().render(RenderingStrategies.MYBATIS3);
125125

@@ -160,7 +160,7 @@ void testSelectVariations(Variation variation) {
160160

161161
builder.and(firstName, isEqualTo(variation.firstName).filter(Objects::nonNull));
162162
builder.or(PersonDynamicSqlSupport.lastName, isEqualTo(variation.lastName).filter(Objects::nonNull));
163-
builder.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true));
163+
builder.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true));
164164

165165
SelectStatementProvider selectStatement = builder.build().render(RenderingStrategies.MYBATIS3);
166166

@@ -202,7 +202,7 @@ void testJoinVariations(Variation variation) {
202202

203203
builder.and(firstName, isEqualTo(variation.firstName).filter(Objects::nonNull));
204204
builder.or(PersonDynamicSqlSupport.lastName, isEqualTo(variation.lastName).filter(Objects::nonNull));
205-
builder.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true));
205+
builder.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true));
206206

207207
SelectStatementProvider selectStatement = builder.build().render(RenderingStrategies.MYBATIS3);
208208

@@ -246,7 +246,7 @@ void testUpdateVariations(Variation variation) {
246246

247247
builder.and(firstName, isEqualTo(variation.firstName).filter(Objects::nonNull));
248248
builder.or(PersonDynamicSqlSupport.lastName, isEqualTo(variation.lastName).filter(Objects::nonNull));
249-
builder.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true));
249+
builder.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true));
250250

251251
UpdateStatementProvider updateStatement = builder.build().render(RenderingStrategies.MYBATIS3);
252252

@@ -283,7 +283,7 @@ void testWhereVariations(Variation variation) {
283283

284284
builder.and(firstName, isEqualTo(variation.firstName).filter(Objects::nonNull));
285285
builder.or(PersonDynamicSqlSupport.lastName, isEqualTo(variation.lastName).filter(Objects::nonNull));
286-
builder.configureStatement(c -> c.setUnrenderableWhereClauseAllowed(true));
286+
builder.configureStatement(c -> c.setNonRenderingWhereClauseAllowed(true));
287287

288288
WhereClauseProvider whereClause = builder.build().render(RenderingStrategies.MYBATIS3);
289289

0 commit comments

Comments
 (0)