com.itextpdf.kernel.utils

Class PageRange

java.lang.Object

com.itextpdf.kernel.utils.PageRange

public class PageRange
extends Object

Class representing a page range, for instance a page range can contain pages 5, then pages 10 through 15, then page 18, then page 21 and so on.

Constructor Summary

Constructors

Constructor and Description
PageRange() Constructs an empty PageRange instance.
PageRange(String pageRange) Constructs a PageRange instance from a range in a string form, for example: "1-12, 15, 45-66".

Method Summary

Modifier and Type	Method and Description
PageRange	addPageSequence(int startPageNumber, int endPageNumber) Adds a page sequence to the range.
PageRange	addSinglePage(int pageNumber) Adds a single page to the range.
boolean	equals(Object obj)
List<Integer>	getAllPages() Gets the list if pages that have been added to the range so far.
int	hashCode()
boolean	isPageInRange(int pageNumber) Checks if a given page is present in the range built so far.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageRange

public PageRange()

Constructs an empty PageRange instance.

PageRange

public PageRange(String pageRange)

Constructs a PageRange instance from a range in a string form, for example: "1-12, 15, 45-66".

Parameters:

pageRange - the page range

Method Detail

addPageSequence

public PageRange addPageSequence(int startPageNumber,
                                 int endPageNumber)

Adds a page sequence to the range.

Parameters:

startPageNumber - the starting page number of the sequence

endPageNumber - the finishing page number of the sequnce

Returns:

this range, already modified

addSinglePage

public PageRange addSinglePage(int pageNumber)

Adds a single page to the range.

Parameters:

pageNumber - the page number to add

Returns:

this range, already modified

getAllPages

public List<Integer> getAllPages()

Gets the list if pages that have been added to the range so far.

Returns:

the list containing page numbers added to the range

isPageInRange

public boolean isPageInRange(int pageNumber)

Checks if a given page is present in the range built so far.

Parameters:

pageNumber - the page number to check

Returns:

true if the page is present in this range, false otherwise

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object