com.atlassian.bitbucket.util

Class AbstractPagedSummary

java.lang.Object

com.atlassian.bitbucket.util.AbstractSummary

com.atlassian.bitbucket.util.AbstractPagedSummary

Direct Known Subclasses:

ContentTreeSummary, FileSummary

public abstract class AbstractPagedSummary
extends AbstractSummary

Extends AbstractSummary and adds additional properties for summarizing a page of output.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPagedSummary.AbstractPagedBuilder<B extends AbstractPagedSummary.AbstractPagedBuilder<B,S>,S extends AbstractPagedSummary>

Nested classes/interfaces inherited from class com.atlassian.bitbucket.util.AbstractSummary

AbstractSummary.AbstractBuilder<B extends AbstractSummary.AbstractBuilder<B,S>,S extends AbstractSummary>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPagedSummary(AbstractPagedSummary.AbstractPagedBuilder<?,?> builder)

Method Summary

Modifier and Type	Method and Description
PageRequest	getNextPageRequest() If this is not the last page, retrieves the PageRequest which can be used to request the next page.
PageRequest	getPageRequest() Retrieves the PageRequest that was used to retrieve this page of results.
int	getSize() Retrieves the number of results that were retrieved.
boolean	isLastPage() Retrieves a flag indicating whether this page is the last page of results.

Methods inherited from class com.atlassian.bitbucket.util.AbstractSummary

getResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractPagedSummary

protected AbstractPagedSummary(@Nonnull
                               AbstractPagedSummary.AbstractPagedBuilder<?,?> builder)

Method Detail

getNextPageRequest

@Nullable
public PageRequest getNextPageRequest()

If this is not the last page, retrieves the PageRequest which can be used to request the next page. If this is the last page, returns null.

Returns:

a PageRequest to request the next page, or null if this is the last page

getPageRequest

@Nonnull
public PageRequest getPageRequest()

Retrieves the PageRequest that was used to retrieve this page of results.

Returns:

the PageRequest for the current page

getSize

public int getSize()

Retrieves the number of results that were retrieved. This value will always be less than or equal to the limit of the current page request.

Returns:

the size of the current page

isLastPage

public boolean isLastPage()

Retrieves a flag indicating whether this page is the last page of results.

Returns:

true if this is the final page of results; otherwise, false if there is a next page