Skip to content

Commit adc4e8a

Browse files
committed
Deprecate methods that should not be used in API
1 parent 4734903 commit adc4e8a

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

src/main/java/com/cloudant/client/api/model/Page.java

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,38 +54,83 @@ public String getPreviousParam() {
5454
return page.getPreviousParam();
5555
}
5656

57+
/**
58+
* Setter methods on {@link Page} should not be called by applications.
59+
* These parameters are controlled internally.
60+
*/
61+
@Deprecated
5762
public void setHasPrevious(boolean isHasPrevious) {
5863
page.setHasPrevious(isHasPrevious);
5964
}
6065

66+
/**
67+
* Setter methods on {@link Page} should not be called by applications.
68+
* These parameters are controlled internally.
69+
*/
70+
@Deprecated
6171
public void setHasNext(boolean isHasNext) {
6272
page.setHasNext(isHasNext);
6373
}
6474

75+
/**
76+
* Setter methods on {@link Page} should not be called by applications.
77+
* These parameters are controlled internally.
78+
*/
79+
@Deprecated
6580
public void setResultList(List<T> resultList) {
6681
page.setResultList(resultList);
6782
}
6883

84+
/**
85+
* Setter methods on {@link Page} should not be called by applications.
86+
* These parameters are controlled internally.
87+
*/
88+
@Deprecated
6989
public void setTotalResults(long totalResults) {
7090
page.setTotalResults(totalResults);
7191
}
7292

93+
/**
94+
* Setter methods on {@link Page} should not be called by applications.
95+
* These parameters are controlled internally.
96+
*/
97+
@Deprecated
7398
public void setResultFrom(int resultFrom) {
7499
page.setResultFrom(resultFrom);
75100
}
76101

102+
/**
103+
* Setter methods on {@link Page} should not be called by applications.
104+
* These parameters are controlled internally.
105+
*/
106+
@Deprecated
77107
public void setResultTo(int resultTo) {
78108
page.setResultTo(resultTo);
79109
}
80110

111+
/**
112+
* Setter methods on {@link Page} should not be called by applications.
113+
* These parameters are controlled internally.
114+
*/
115+
@Deprecated
81116
public void setPageNumber(int pageNumber) {
82117
page.setPageNumber(pageNumber);
83118
}
84119

120+
/**
121+
* Setter methods on {@link Page} should not be called by applications.
122+
* These parameters are controlled internally.
123+
*/
124+
@Deprecated
85125
public void setNextParam(String nextParam) {
86126
page.setNextParam(nextParam);
87127
}
88128

129+
/**
130+
* Setter methods on {@link Page} should not be called by applications.
131+
* These parameters are controlled internally.
132+
*/
133+
@Deprecated
89134
public void setPreviousParam(String previousParam) {
90135
page.setPreviousParam(previousParam);
91136
}

src/main/java/com/cloudant/client/api/model/ViewResult.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ public long getUpdateSeq() {
4646
}
4747

4848
/**
49+
* Offset should not be used in clustered environments
4950
* @return
5051
*/
52+
@Deprecated
5153
public int getOffset() {
5254
return viewResult.getOffset();
5355
}
@@ -81,8 +83,10 @@ public void setUpdateSeq(long updateSeq) {
8183
}
8284

8385
/**
86+
* Offset should not be used in clustered environments
8487
* @param offset
8588
*/
89+
@Deprecated
8690
public void setOffset(int offset) {
8791
viewResult.setOffset(offset);
8892
}

0 commit comments

Comments
 (0)