1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*
* SonarQube
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.utils;
/**
* @since 3.6
*/
public class Paging {
private final int pageSize;
private final int pageIndex;
private final int total;
private Paging(int pageSize, int pageIndex, int total) {
if (pageSize < 1) {
throw new IllegalArgumentException("Page size must be strictly positive. Got " + pageSize);
}
if (pageIndex < 1) {
throw new IllegalArgumentException("Page index must be strictly positive. Got " + pageIndex);
}
if (total < 0) {
throw new IllegalArgumentException("Total items must be positive. Got " + total);
}
this.pageSize = pageSize;
this.pageIndex = pageIndex;
this.total = total;
}
/**
* @deprecated since 5.2 please use the forPageIndex(...) builder method
*/
@Deprecated
public static Paging create(int pageSize, int pageIndex, int totalItems) {
return new Paging(pageSize, pageIndex, totalItems);
}
public static Builder forPageIndex(int pageIndex) {
return new Builder(pageIndex);
}
/**
* Page index, starting with 1.
*/
public int pageIndex() {
return pageIndex;
}
/**
* Maximum number of items per page. It is greater than 0.
*/
public int pageSize() {
return pageSize;
}
/**
* Total number of items. It is greater than or equal 0.
*/
public int total() {
return total;
}
public int offset() {
return (pageIndex - 1) * pageSize;
}
public static int offset(int pageIndex, int pageSize) {
return (pageIndex - 1) * pageSize;
}
/**
* Number of pages. It is greater than or equal 0.
*/
public int pages() {
int p = total / pageSize;
if (total % pageSize > 0) {
p++;
}
return p;
}
/**
*
* @since 4.1
*/
public boolean hasNextPage() {
return pageIndex() < pages();
}
public static class Builder {
private int pageSize;
private int pageIndex;
private Builder(int pageIndex) {
this.pageIndex = pageIndex;
}
public Builder withPageSize(int pageSize) {
this.pageSize = pageSize;
return this;
}
public Paging andTotal(int total) {
return new Paging(pageSize, pageIndex, total);
}
}
}
|
