Add JavaDocs

Do using IntelliJ JavaDocs plugin. Better to have something than nothing.
This commit is contained in:
Liam Newman
2019-11-14 13:24:28 -08:00
parent f6a01551fd
commit 757b9b2118
125 changed files with 7379 additions and 251 deletions

View File

@@ -8,6 +8,8 @@ import java.util.Set;
/**
* {@link Iterable} that returns {@link PagedIterator}
*
* @param <T>
* the type parameter
* @author Kohsuke Kawaguchi
*/
public abstract class PagedIterable<T> implements Iterable<T> {
@@ -21,6 +23,10 @@ public abstract class PagedIterable<T> implements Iterable<T> {
*
* <p>
* When set to non-zero, each API call will retrieve this many entries.
*
* @param size
* the size
* @return the paged iterable
*/
public PagedIterable<T> withPageSize(int size) {
this.size = size;
@@ -31,10 +37,19 @@ public abstract class PagedIterable<T> implements Iterable<T> {
return _iterator(size);
}
/**
* Iterator paged iterator.
*
* @param pageSize
* the page size
* @return the paged iterator
*/
public abstract PagedIterator<T> _iterator(int pageSize);
/**
* Eagerly walk {@link Iterable} and return the result in a list.
*
* @return the list
*/
public List<T> asList() {
List<T> r = new ArrayList<T>();
@@ -46,6 +61,8 @@ public abstract class PagedIterable<T> implements Iterable<T> {
/**
* Eagerly walk {@link Iterable} and return the result in a set.
*
* @return the set
*/
public Set<T> asSet() {
LinkedHashSet<T> r = new LinkedHashSet<T>();