Class PageList<E>

java.lang.Object
org.exoplatform.commons.utils.PageList<E>
Direct Known Subclasses:
LazyPageList, ObjectPageList

public abstract class PageList<E> extends Object
Deprecated.
Subclasses of this object should be replaced by the subclass and an implementation of the ListAccess interface.
  • Field Details

    • EMPTY_LIST

      public static final PageList EMPTY_LIST
      Deprecated.
    • available_

      protected int available_
      Deprecated.
    • availablePage_

      protected int availablePage_
      Deprecated.
    • currentPage_

      protected int currentPage_
      Deprecated.
    • currentListPage_

      protected List<E> currentListPage_
      Deprecated.
  • Constructor Details

    • PageList

      public PageList(int pageSize)
      Deprecated.
  • Method Details

    • getPageSize

      public int getPageSize()
      Deprecated.
      Returns the page size.
      Returns:
      the page size
    • setPageSize

      public void setPageSize(int pageSize)
      Deprecated.
      Updates the page size.
      Parameters:
      pageSize - the new page size value
    • getCurrentPage

      public int getCurrentPage()
      Deprecated.
      Returns the current page index.
      Returns:
      the current page
    • getAvailable

      public int getAvailable()
      Deprecated.
      Returns the number of available elements.
      Returns:
      the available elements
    • getAvailablePage

      public int getAvailablePage()
      Deprecated.
      Returns the number of available pages.
      Returns:
      the available pages
    • currentPage

      public List<E> currentPage() throws Exception
      Deprecated.
      Throws:
      Exception
    • populateCurrentPage

      protected abstract void populateCurrentPage(int page) throws Exception
      Deprecated.
      Throws:
      Exception
    • getPage

      public List<E> getPage(int page) throws Exception
      Deprecated.
      Updates the current page index and retrieves the element from that page.
      Parameters:
      page - the page index
      Returns:
      the list of element of the page
      Throws:
      Exception - an exception
    • getAll

      public abstract List<E> getAll() throws Exception
      Deprecated.
      Throws:
      Exception
    • checkAndSetPage

      protected void checkAndSetPage(int page) throws Exception
      Deprecated.
      Throws:
      Exception
    • setAvailablePage

      protected void setAvailablePage(int available)
      Deprecated.
    • getFrom

      public int getFrom()
      Deprecated.
      Returns the from index.
      Returns:
      the from index
    • getTo

      public int getTo()
      Deprecated.
      Returns the to index.
      Returns:
      the to index