Package com.inet.report.cache

Class PageOutOfRangeException

  • All Implemented Interfaces:
    com.inet.error.HasErrorCode, java.io.Serializable
    public class PageOutOfRangeException
extends ReportException
    This exception is thrown if a page is requested with a page number larger than the total number of pages, or is less than 0.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      PageOutOfRangeException​(int page, int pageCount)
      Creates a PageOutOfRangeException which is thrown if a page is requested with a page number larger than the total number of pages, or is less than 0.
      PageOutOfRangeException​(int page, int pageCount, java.lang.String stopCause)
      Creates a PageOutOfRangeException which is thrown if a page is requested with a page number larger than the total number of pages, or is less than 0.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getPage()
      Get the requested page number.
      int getPageCount()
      Get the highest legal page number.

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PageOutOfRangeException

        public PageOutOfRangeException​(int page,
                               int pageCount)
        Creates a PageOutOfRangeException which is thrown if a page is requested with a page number larger than the total number of pages, or is less than 0.
        Parameters:
        page - Number of page requested, which caused the exception
        pageCount - Total number of pages in the report
        Since:
        6.0

      • PageOutOfRangeException

        public PageOutOfRangeException​(int page,
                               int pageCount,
                               java.lang.String stopCause)
        Creates a PageOutOfRangeException which is thrown if a page is requested with a page number larger than the total number of pages, or is less than 0.
        Parameters:
        page - Number of page requested, which caused the exception
        pageCount - Total number of pages in the report
        stopCause - optional cause of stopping
        Since:
        16.1

    • Method Detail

      • getPage

        public final int getPage()
        Get the requested page number.
        Returns:
        the requested page that is out of range
        Since:
        6.0

      • getPageCount

        public final int getPageCount()
        Get the highest legal page number.
        Returns:
        available pages
        Since:
        6.0