org.sejda.model.parameter

Class ExtractPagesParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.base.AbstractPdfOutputParameters

org.sejda.model.parameter.base.SinglePdfSourceSingleOutputParameters

org.sejda.model.parameter.ExtractPagesParameters

All Implemented Interfaces:

SingleOutputTaskParameters, SinglePdfSourceTaskParameters, TaskParameters, PageRangeSelection, PagesSelection

@NoIntersections
@SingleOutputAllowedExtensions
@HasSelectedPages
public class ExtractPagesParameters
extends SinglePdfSourceSingleOutputParameters
implements PageRangeSelection, PagesSelection

Parameter class for an Extract pages task. Allow to specify a predefined set of pages to extract (odd, even) or a set of page ranges but not both. Page ranges are validated to make sure that there is no intersection.

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
ExtractPagesParameters() Creates and empty instance where page selection can be set
ExtractPagesParameters(PredefinedSetOfPages predefinedSetOfPages) Creates an instance using a predefined set of pages to extract.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllPageRanges(Collection<PageRange> ranges)
void	addPageRange(PageRange range)
boolean	equals(Object other)
Set<Integer>	getPages(int upperLimit)
Set<PageRange>	getPageSelection()
PredefinedSetOfPages	getPredefinedSetOfPages()
PdfSource<?>	getSource()
int	hashCode()
void	setSource(PdfSource<?> source) Set the source for this parameter.

Methods inherited from class org.sejda.model.parameter.base.SinglePdfSourceSingleOutputParameters

getOutput, getOutputName, setOutput, setOutputName

Methods inherited from class org.sejda.model.parameter.base.AbstractPdfOutputParameters

getMinRequiredPdfVersion, getVersion, isCompress, setCompress, setVersion

Methods inherited from class org.sejda.model.parameter.base.AbstractParameters

isOverwrite, setOverwrite, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sejda.model.parameter.base.TaskParameters

isOverwrite

Constructor Detail

ExtractPagesParameters

public ExtractPagesParameters()

Creates and empty instance where page selection can be set

ExtractPagesParameters

public ExtractPagesParameters(PredefinedSetOfPages predefinedSetOfPages)

Creates an instance using a predefined set of pages to extract.

Parameters:

predefinedSetOfPages -

Method Detail

addPageRange

public void addPageRange(PageRange range)

addAllPageRanges

public void addAllPageRanges(Collection<PageRange> ranges)

getPredefinedSetOfPages

public PredefinedSetOfPages getPredefinedSetOfPages()

getPageSelection

public Set<PageRange> getPageSelection()

Specified by:

getPageSelection in interface PageRangeSelection

Returns:

an unmodifiable view of the pageSelection

getPages

public Set<Integer> getPages(int upperLimit)

Specified by:

getPages in interface PagesSelection

Parameters:

upperLimit - the number of pages of the document (upper limit).

Returns:

the selected set of pages. Iteration ordering is predictable, it is the order in which elements were inserted into the PageRange set or the natural order in case of PredefinedSetOfPages.

See Also:

PagesSelection.getPages(int)

hashCode

public int hashCode()

Overrides:

hashCode in class SinglePdfSourceSingleOutputParameters

equals

public boolean equals(Object other)

Overrides:

equals in class SinglePdfSourceSingleOutputParameters

getSource

public PdfSource<?> getSource()

Specified by:

getSource in interface SinglePdfSourceTaskParameters

Returns:

the source for this parameter.

setSource

public void setSource(PdfSource<?> source)

Description copied from interface: SinglePdfSourceTaskParameters

Set the source for this parameter.

Specified by:

setSource in interface SinglePdfSourceTaskParameters