com.atlassian.confluence.api.model.pagination

Class SpaceCursor

java.lang.Object

com.atlassian.confluence.api.model.pagination.SpaceCursor

All Implemented Interfaces:

Cursor

public class SpaceCursor
extends Object
implements Cursor

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

Since:

7.18

Field Summary

Fields

Modifier and Type	Field and Description
static SpaceCursor	EMPTY_CURSOR

Method Summary

Modifier and Type	Method and Description
static SpaceCursor	createCursor(boolean isReverse, Long spaceId)
boolean	equals(Object o)
CursorType	getCursorType()
Long	getSpaceId()
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 SpaceCursor	valueOf(@NonNull String cursorToken)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_CURSOR

public static final SpaceCursor EMPTY_CURSOR

Method Detail

createCursor

public static SpaceCursor createCursor(boolean isReverse,
                                       Long spaceId)

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)

getSpaceId

public Long getSpaceId()

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 SpaceCursor valueOf(@NonNull String cursorToken)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object