graphql.relay.PageInfo Maven / Gradle / Ivy
package graphql.relay;
import graphql.PublicApi;
/**
* Represents pagination information in Relay about {@link graphql.relay.Edge edges} when used
* inside a {@link graphql.relay.Connection connection}
*
* See https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
*/
@PublicApi
public interface PageInfo {
/**
* @return cursor to the first edge, or null if this page is empty.
*/
ConnectionCursor getStartCursor();
/**
* @return cursor to the last edge, or null if this page is empty.
*/
ConnectionCursor getEndCursor();
/**
* @return true if and only if this page is not the first page. only meaningful when you gave the {@code last} argument.
*/
boolean isHasPreviousPage();
/**
* @return true if and only if this page is not the last page. only meaningful when you gave the {@code first} argument.
*/
boolean isHasNextPage();
}