1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.search.api.request;
20
21 /**
22 * Paging.
23 */
24 public final class Paging {
25 private final int pageSize;
26
27 private final int pageOffset;
28
29 /**
30 * Creates paging instance with given page size (must be greater than 0) and page offset (must be non-negative).
31 */
32 public Paging(int pageSize, int pageOffset) {
33 if (pageSize < 1) {
34 throw new IllegalArgumentException("pageSize");
35 }
36 if (pageOffset < 0) {
37 throw new IllegalArgumentException("pageOffset");
38 }
39 this.pageSize = pageSize;
40 this.pageOffset = pageOffset;
41 }
42
43 /**
44 * Creates paging instance with given page size (must be grater than 0) and 0 page offset.
45 */
46 public Paging(int pageSize) {
47 this(pageSize, 0);
48 }
49
50 /**
51 * Returns the page size: positive integer, never zero or less.
52 */
53 public int getPageSize() {
54 return pageSize;
55 }
56
57 /**
58 * Returns the page offset: a zero or a positive integer.
59 */
60 public int getPageOffset() {
61 return pageOffset;
62 }
63
64 /**
65 * Creates "next page" instance relative to this instance.
66 */
67 public Paging nextPage() {
68 return new Paging(pageSize, pageOffset + 1);
69 }
70
71 @Override
72 public String toString() {
73 return getClass().getSimpleName() + "{pageSize=" + pageSize + ", pageOffset=" + pageOffset + "}";
74 }
75 }