Skip to content

Commit bf6b28c

Browse files
authored
Merge pull request #491 from turkraft/3.x.x
@page -> @Pagination
2 parents d7ab2db + 49dc452 commit bf6b28c

10 files changed

Lines changed: 65 additions & 65 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Filter JPA entities directly in database queries. The module converts filter exp
5959
<dependency>
6060
<groupId>com.turkraft.springfilter</groupId>
6161
<artifactId>jpa</artifactId>
62-
<version>3.2.4</version>
62+
<version>3.2.5</version>
6363
</dependency>
6464
```
6565

@@ -114,7 +114,7 @@ Filter MongoDB documents using Spring Data MongoDB queries.
114114
<dependency>
115115
<groupId>com.turkraft.springfilter</groupId>
116116
<artifactId>mongo</artifactId>
117-
<version>3.2.4</version>
117+
<version>3.2.5</version>
118118
</dependency>
119119
```
120120

@@ -150,7 +150,7 @@ Filter in-memory collections using Java Predicates. Works with any POJO, no data
150150
<dependency>
151151
<groupId>com.turkraft.springfilter</groupId>
152152
<artifactId>predicate</artifactId>
153-
<version>3.2.4</version>
153+
<version>3.2.5</version>
154154
</dependency>
155155
```
156156

@@ -222,7 +222,7 @@ Build filter expressions programmatically instead of writing filter strings manu
222222
<dependency>
223223
<groupId>com.turkraft.springfilter</groupId>
224224
<artifactId>core</artifactId>
225-
<version>3.2.4</version>
225+
<version>3.2.5</version>
226226
</dependency>
227227
```
228228

@@ -268,7 +268,7 @@ Add automatic Swagger documentation for endpoints with `@Filter` parameters.
268268
<dependency>
269269
<groupId>com.turkraft.springfilter</groupId>
270270
<artifactId>openapi</artifactId>
271-
<version>3.2.4</version>
271+
<version>3.2.5</version>
272272
</dependency>
273273
```
274274

@@ -290,15 +290,15 @@ The `page-sort` module provides annotations for pagination, sorting, and field s
290290
<dependency>
291291
<groupId>com.turkraft.springfilter</groupId>
292292
<artifactId>page-sort</artifactId>
293-
<version>3.2.4</version>
293+
<version>3.2.5</version>
294294
</dependency>
295295
```
296296

297297
### Basic Usage
298298

299299
```java
300300
@GetMapping("/cars")
301-
Page<Car> search(@Filter Specification<Car> spec, @Page Pageable page) {
301+
Page<Car> search(@Filter Specification<Car> spec, @Pagination Pageable page) {
302302
return repository.findAll(spec, page);
303303
}
304304
```
@@ -310,7 +310,7 @@ Usage: `?page=0&size=20&sort=-year` (prefix `-` for descending)
310310
```java
311311
@GetMapping("/cars")
312312
Page<Car> search(
313-
@Page(pageParameter = "p", sizeParameter = "limit", sortParameter = "order") Pageable page) {
313+
@Pagination(pageParameter = "p", sizeParameter = "limit", sortParameter = "order") Pageable page) {
314314
return repository.findAll(page);
315315
}
316316
```
@@ -361,7 +361,7 @@ Use `?fields=id,brand.name,year` to return only specified fields. Uses Jackson's
361361
@GetMapping("/cars")
362362
Page<Car> search(
363363
@Filter Specification<Car> spec,
364-
@Page Pageable page) {
364+
@Pagination Pageable page) {
365365
return repository.findAll(spec, page);
366366
}
367367
```

core/src/main/java/com/turkraft/springfilter/language/InOperator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public String getDescription() {
1717

1818
@Override
1919
public String getExample() {
20-
return "status in ('active', 'pending')";
20+
return "status in ['active', 'pending']";
2121
}
2222

2323
}

jpa-example/src/main/java/com/turkraft/springfilter/example/SpringFilterJpaExampleApplication.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import com.github.javafaker.Faker;
44
import com.turkraft.springfilter.boot.Fields;
55
import com.turkraft.springfilter.boot.Filter;
6-
import com.turkraft.springfilter.boot.Page;
6+
import com.turkraft.springfilter.boot.Pagination;
77
import com.turkraft.springfilter.converter.FilterSpecification;
88
import com.turkraft.springfilter.example.model.Address;
99
import com.turkraft.springfilter.example.model.Company;
@@ -170,7 +170,7 @@ public void index(HttpServletResponse response)
170170
@Fields
171171
public List<Industry> getIndustries(
172172
@Filter FilterSpecification<Industry> filter,
173-
@Page Pageable pageable) {
173+
@Pagination Pageable pageable) {
174174
return industryRepository
175175
.findAll(filter, pageable)
176176
.getContent();
@@ -180,7 +180,7 @@ public List<Industry> getIndustries(
180180
@Fields
181181
public List<Company> getCompanies(
182182
@Filter FilterSpecification<Company> filter,
183-
@Page Pageable pageable) {
183+
@Pagination Pageable pageable) {
184184
return companyRepository
185185
.findAll(filter, pageable)
186186
.getContent();
@@ -190,7 +190,7 @@ public List<Company> getCompanies(
190190
@Fields
191191
public List<Employee> getEmployees(
192192
@Filter FilterSpecification<Employee> filter,
193-
@Page Pageable pageable) {
193+
@Pagination Pageable pageable) {
194194
return employeeRepository
195195
.findAll(filter, pageable)
196196
.getContent();
@@ -200,7 +200,7 @@ public List<Employee> getEmployees(
200200
@Fields
201201
public List<Payslip> getPayslips(
202202
@Filter FilterSpecification<Payslip> filter,
203-
@Page Pageable pageable) {
203+
@Pagination Pageable pageable) {
204204
return payslipRepository
205205
.findAll(filter, pageable)
206206
.getContent();

mongo-example/src/main/java/com/turkraft/springfilter/example/SpringFilterMongoExampleApplication.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import com.github.javafaker.Faker;
44
import com.turkraft.springfilter.boot.Fields;
55
import com.turkraft.springfilter.boot.Filter;
6-
import com.turkraft.springfilter.boot.Page;
6+
import com.turkraft.springfilter.boot.Pagination;
77
import com.turkraft.springfilter.example.model.Company;
88
import com.turkraft.springfilter.example.model.Employee;
99
import com.turkraft.springfilter.example.model.Employee.MaritalStatus;
@@ -183,7 +183,7 @@ public void index(HttpServletResponse response)
183183
@Fields
184184
public List<Industry> getIndustries(
185185
@Filter(entityClass = Industry.class) Document filter,
186-
@Page Pageable pageable) {
186+
@Pagination Pageable pageable) {
187187
Query query = new BasicQuery(filter);
188188
query.with(pageable);
189189
return mongoTemplate.find(query, Industry.class);
@@ -193,7 +193,7 @@ public List<Industry> getIndustries(
193193
@Fields
194194
public List<Company> getCompanies(
195195
@Filter(entityClass = Company.class) Document filter,
196-
@Page Pageable pageable) {
196+
@Pagination Pageable pageable) {
197197
Query query = new BasicQuery(filter);
198198
query.with(pageable);
199199
return mongoTemplate.find(query, Company.class);
@@ -203,7 +203,7 @@ public List<Company> getCompanies(
203203
@Fields
204204
public List<Employee> getEmployees(
205205
@Filter(entityClass = Employee.class) Document filter,
206-
@Page Pageable pageable) {
206+
@Pagination Pageable pageable) {
207207
Query query = new BasicQuery(filter);
208208
query.with(pageable);
209209
return mongoTemplate.find(query, Employee.class);
@@ -213,7 +213,7 @@ public List<Employee> getEmployees(
213213
@Fields
214214
public List<Payslip> getPayslips(
215215
@Filter(entityClass = Payslip.class) Document filter,
216-
@Page Pageable pageable) {
216+
@Pagination Pageable pageable) {
217217
Query query = new BasicQuery(filter);
218218
query.with(pageable);
219219
return mongoTemplate.find(query, Payslip.class);

openapi/src/main/java/com/turkraft/springfilter/openapi/FilterOpenApiAutoConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public FilterParameterCustomizer filterParameterCustomizer(
7272
@ConditionalOnMissingBean
7373
@ConditionalOnClass(name = {
7474
"com.turkraft.springfilter.boot.Sort",
75-
"com.turkraft.springfilter.boot.Page",
75+
"com.turkraft.springfilter.boot.Pagination",
7676
"com.turkraft.springfilter.boot.Fields"
7777
})
7878
public PageSortParameterCustomizer pageSortParameterCustomizer(

openapi/src/main/java/com/turkraft/springfilter/openapi/springdoc/PageSortParameterCustomizer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public Operation customize(@Nullable Operation operation, @Nullable HandlerMetho
5757
try {
5858

5959
Class<?> sortAnnotation = Class.forName("com.turkraft.springfilter.boot.Sort");
60-
Class<?> pageAnnotation = Class.forName("com.turkraft.springfilter.boot.Page");
60+
Class<?> pageAnnotation = Class.forName("com.turkraft.springfilter.boot.Pagination");
6161

6262
Object sort = parameter.getAnnotation((Class) sortAnnotation);
6363
Object page = parameter.getAnnotation((Class) pageAnnotation);

openapi/src/test/java/com/turkraft/springfilter/openapi/PageSortParameterCustomizerTest.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import static org.mockito.Mockito.when;
99

1010
import com.turkraft.springfilter.boot.Fields;
11-
import com.turkraft.springfilter.boot.Page;
11+
import com.turkraft.springfilter.boot.Pagination;
1212
import com.turkraft.springfilter.boot.Sort;
1313
import com.turkraft.springfilter.openapi.introspection.EntityIntrospector;
1414
import com.turkraft.springfilter.openapi.springdoc.PageSortParameterCustomizer;
@@ -357,18 +357,18 @@ public String withSortAnnotation(@Sort(parameter = "customSort", required = true
357357
}
358358

359359
@GetMapping("/page")
360-
public String withPage(@Page Pageable page) {
360+
public String withPage(@Pagination Pageable page) {
361361
return "ok";
362362
}
363363

364364
@GetMapping("/page-annotation")
365365
public String withPageAnnotation(
366-
@Page(pageParameter = "p", sizeParameter = "s", sortParameter = "order", defaultPage = 1, defaultSize = 50, maxSize = 200) Pageable page) {
366+
@Pagination(pageParameter = "p", sizeParameter = "s", sortParameter = "order", defaultPage = 1, defaultSize = 50, maxSize = 200) Pageable page) {
367367
return "ok";
368368
}
369369

370370
@GetMapping("/page-no-sort")
371-
public String withPageNoSort(@Page(enableSort = false) Pageable page) {
371+
public String withPageNoSort(@Pagination(enableSort = false) Pageable page) {
372372
return "ok";
373373
}
374374

@@ -388,7 +388,7 @@ public String withFieldsAnnotation() {
388388
@GetMapping("/all")
389389
public String withAllAnnotations(
390390
@Sort org.springframework.data.domain.Sort sort,
391-
@Page Pageable page) {
391+
@Pagination Pageable page) {
392392
return "ok";
393393
}
394394

page-sort/src/main/java/com/turkraft/springfilter/boot/PageArgumentResolver.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public PageArgumentResolver(SortParser sortParser) {
2121

2222
@Override
2323
public boolean supportsParameter(MethodParameter parameter) {
24-
return parameter.hasParameterAnnotation(Page.class)
24+
return parameter.hasParameterAnnotation(Pagination.class)
2525
&& Pageable.class.isAssignableFrom(parameter.getParameterType());
2626
}
2727

@@ -30,9 +30,9 @@ public Object resolveArgument(MethodParameter parameter,
3030
ModelAndViewContainer mavContainer, NativeWebRequest webRequest,
3131
WebDataBinderFactory binderFactory) {
3232

33-
Page pageAnnotation = parameter.getParameterAnnotation(Page.class);
33+
Pagination pageAnnotation = parameter.getParameterAnnotation(Pagination.class);
3434
if (pageAnnotation == null) {
35-
return PageRequest.of(Page.DEFAULT_PAGE, Page.DEFAULT_SIZE);
35+
return PageRequest.of(Pagination.DEFAULT_PAGE, Pagination.DEFAULT_SIZE);
3636
}
3737

3838
String pageParam = webRequest.getParameter(pageAnnotation.pageParameter());

page-sort/src/main/java/com/turkraft/springfilter/boot/Page.java renamed to page-sort/src/main/java/com/turkraft/springfilter/boot/Pagination.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
@Retention(RetentionPolicy.RUNTIME)
99
@Target(ElementType.PARAMETER)
10-
public @interface Page {
10+
public @interface Pagination {
1111

1212
String DEFAULT_PAGE_PARAMETER = "page";
1313

0 commit comments

Comments
 (0)