org.sejda.model.parameter

Class SplitByPagesParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.base.AbstractPdfOutputParameters

org.sejda.model.parameter.base.MultiplePdfSourceParameters

org.sejda.model.parameter.base.MultiplePdfSourceMultipleOutputParameters

org.sejda.model.parameter.AbstractSplitByPageParameters

org.sejda.model.parameter.SplitByPagesParameters

All Implemented Interfaces:

DiscardableOutlineTaskParameters, MultiplePdfSourceTaskParameters, OptimizableOutputTaskParameters, PrefixableTaskParameters, SingleOrMultipleOutputTaskParameters, TaskParameters, PagesSelection

public class SplitByPagesParameters
extends AbstractSplitByPageParameters

Parameter class for a split by page task. Used to perform split at a given set of page numbers.

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
SplitByPagesParameters()

Method Summary

Modifier and Type	Method and Description
void	addPage(Integer page) Adds a page to split at.
void	addPages(Collection<Integer> pagesToAdd) Adds all pages to split at.
boolean	equals(Object other)
Set<Integer>	getPages(int upperLimit)
int	hashCode()
String	toString()

Methods inherited from class org.sejda.model.parameter.AbstractSplitByPageParameters

discardOutline, discardOutline, getOptimizationPolicy, setOptimizationPolicy

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

getOutput, getOutputPrefix, setOutput, setOutputPrefix

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

addSource, addSources, getSourceList, removeAllSources

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

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient

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

getExistingOutputPolicy, getOutput, isLenient, setExistingOutputPolicy, setLenient

Constructor Detail

SplitByPagesParameters

public SplitByPagesParameters()

Method Detail

addPages

public void addPages(Collection<Integer> pagesToAdd)

Adds all pages to split at.

Parameters:

pagesToAdd -

addPage

public void addPage(Integer page)

Adds a page to split at.

Parameters:

page -

getPages

public Set<Integer> getPages(int upperLimit)

Parameters:

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

Returns:

the selected set of pages. No constraint is imposed on the predictability of the iteration order but implementors may explicitly state if grant predictable iteration order.

toString

public String toString()

Overrides:

toString in class AbstractParameters

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSplitByPageParameters

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractSplitByPageParameters