Package com.atlassian.confluence.api.service.pagination

Class CursorFactory

java.lang.Object
com.atlassian.confluence.api.service.pagination.CursorFactory
public class CursorFactory extends Object
Factory to create cursor entities
Since:
7.18

  • Method Details

    • registerCursorInstanceCreator

      public static void registerCursorInstanceCreator(String cursorType, Function<String,Cursor> function)
      Additional cursor types could be registered through this method.
      Parameters:
      cursorType - Cursor type (name)
      function - Function that could create instance of the cursor from string
      Since:
      9.2.5

    • unregisterCursorInstanceCreator

      public static void unregisterCursorInstanceCreator(String cursorType)
      Unregister a cursor type creator.
      Parameters:
      cursorType - Cursor type (name) to unregister
      Since:
      9.2.11

    • registerEmptyContentCursor

      public static void registerEmptyContentCursor(ContentType contentType, Cursor emptyCursor)
      Register an empty cursor for a content type.
      Parameters:
      contentType - the content type
      emptyCursor - the empty cursor instance for this content type
      Since:
      9.2.11

    • unregisterEmptyContentCursor

      public static void unregisterEmptyContentCursor(ContentType contentType)
      Unregister an empty cursor for a content type.
      Parameters:
      contentType - the content type to unregister
      Since:
      9.2.11

    • buildFrom

      public static Cursor buildFrom(String cursorString)
      Create cursor from string
      Parameters:
      cursorString - Cursor in string format
      Returns:
      Cursor entity or null if string is null or empty

    • getEmptyCursorBy

      public static Cursor getEmptyCursorBy(ContentType contentType)
      Parameters:
      contentType - the ContentType to get the empty cursor for
      Returns:
      the empty ContentCursor for that content type
      Since:
      9.2.6