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

Class CustomContentCursor

java.lang.Object

com.atlassian.confluence.api.model.pagination.CustomContentCursor

All Implemented Interfaces:

Cursor

public class CustomContentCursor
extends Object
implements Cursor

A cursor implementation for custom content types (e.g., "calendar", "question"). Supports cursor format like "calendar:false:123". Field customContentType matches the scanType in CustomContentProvider.

Since:

9.2.11

Method Summary

Modifier and Type	Method	Description
static CustomContentCursor	createCursor(String customContentType, boolean isReverse, long contentId)
static CustomContentCursor	createEmptyCursor(String customContentType)
boolean	equals(Object o)
Long	getContentId()
CursorType	getCursorType()
String	getCustomContentType()
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 CustomContentCursor	valueOf(@NonNull String cursorToken)

Methods inherited from class java.lang.Object

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

Method Details

createCursor

public static CustomContentCursor createCursor(String customContentType,
 boolean isReverse,
 long contentId)

createEmptyCursor

public static CustomContentCursor createEmptyCursor(String customContentType)

valueOf

public static CustomContentCursor valueOf(@NonNull String cursorToken)

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)

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

getCustomContentType

public String getCustomContentType()

getContentId

public Long getContentId()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object