Package com.atlassian.confluence.api.model.pagination

Class ContentCursor

java.lang.Object

com.atlassian.confluence.api.model.pagination.ContentCursor

All Implemented Interfaces:

Cursor

public class ContentCursor
extends Object
implements Cursor

A class which could be used to generate cursor for the next/previous content pagination request or get cursor from string

Since:

7.18

Field Summary

Fields

Modifier and Type	Field	Description
static final ContentCursor	EMPTY_ATTACHMENT_CURSOR
static final ContentCursor	EMPTY_BLOGPOST_CURSOR
static final ContentCursor	EMPTY_BLOGPOST_CURSOR_PREV
static final ContentCursor	EMPTY_COMMENT_CURSOR
static final ContentCursor	EMPTY_CURSOR
static final ContentCursor	EMPTY_CURSOR_PREV

Method Summary

Modifier and Type	Method	Description
static ContentCursor	createCursor(boolean isReverse, long contentId)	Create a cursor for CONTENT type Notes: please using another override method to create different cursor type
static ContentCursor	createCursor(boolean isReverse, long contentId, CursorType cursorType)
boolean	equals(Object o)
Long	getContentId()
CursorType	getCursorType()
int	hashCode()
boolean	isEmpty()	Indicates that cursor is empty (first cursor in forward direction)
boolean	isReverse()	Indicates that records should be sorted in backward direction when this cursor is used
String	toString()
static ContentCursor	valueOf(@NonNull String cursorToken)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY_CURSOR

public static final ContentCursor EMPTY_CURSOR

EMPTY_CURSOR_PREV

public static final ContentCursor EMPTY_CURSOR_PREV

EMPTY_BLOGPOST_CURSOR

public static final ContentCursor EMPTY_BLOGPOST_CURSOR

EMPTY_BLOGPOST_CURSOR_PREV

public static final ContentCursor EMPTY_BLOGPOST_CURSOR_PREV

EMPTY_COMMENT_CURSOR

public static final ContentCursor EMPTY_COMMENT_CURSOR

EMPTY_ATTACHMENT_CURSOR

public static final ContentCursor EMPTY_ATTACHMENT_CURSOR

Method Details

createCursor

public static ContentCursor createCursor(boolean isReverse,
 long contentId)

Create a cursor for CONTENT type Notes: please using another override method to create different cursor type

Parameters:

isReverse -

contentId -

Returns:

new cursor instance

createCursor

public static ContentCursor createCursor(boolean isReverse,
 long contentId,
 CursorType cursorType)

getCursorType

public CursorType getCursorType()

Specified by:

getCursorType in interface Cursor

Returns:

Type of the cursor

isReverse

public boolean isReverse()

Description copied from interface: Cursor

Indicates that records should be sorted in backward direction when this cursor is used

Specified by:

isReverse in interface Cursor

Returns:

true if this cursor is previous cursor (records go in backward direction)

getContentId

public Long getContentId()

isEmpty

public boolean isEmpty()

Description copied from interface: Cursor

Indicates that cursor is empty (first cursor in forward direction)

Specified by:

isEmpty in interface Cursor

Returns:

true if cursor is empty

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static ContentCursor valueOf(@NonNull String cursorToken)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object