org.sejda.model.parameter

Class MergeParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.base.AbstractPdfOutputParameters

org.sejda.model.parameter.MergeParameters

All Implemented Interfaces:

SingleOutputTaskParameters, TaskParameters

@SingleOutputAllowedExtensions
public class MergeParameters
extends AbstractPdfOutputParameters
implements SingleOutputTaskParameters

Parameter class for a merge task containing a collection of input to be merged.

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
MergeParameters()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInput(PdfMergeInput input) adds the given input to the list of inputs for the merge task.
boolean	equals(Object other)
List<PdfMergeInput>	getInputList()
OutlinePolicy	getOutlinePolicy()
SingleTaskOutput<?>	getOutput()
String	getOutputName()
int	hashCode()
boolean	isBlankPageIfOdd()
boolean	isCopyFormFields()
void	setBlankPageIfOdd(boolean blankPageIfOdd) Setting this true tells the task to add a blank page after each merged document if the number of pages is odd.
void	setCopyFormFields(boolean copyFormFields) Setting this true tells the task to try to merge form fields if any of the input document has forms.
void	setOutlinePolicy(OutlinePolicy outlinePolicy) The policy that the merge task should use when handling the outline tree (bookmarks)
void	setOutput(SingleTaskOutput<?> output) Sets the output destination
void	setOutputName(String outputName)

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

MergeParameters

public MergeParameters()

Method Detail

getOutput

public SingleTaskOutput<?> getOutput()

Specified by:

getOutput in interface TaskParameters

Returns:

output destination where the result of the manipulation is placed

setOutput

public void setOutput(SingleTaskOutput<?> output)

Description copied from interface: SingleOutputTaskParameters

Sets the output destination

Specified by:

setOutput in interface SingleOutputTaskParameters

getInputList

public List<PdfMergeInput> getInputList()

Returns:

an unmodifiable view of the inputList

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface SingleOutputTaskParameters

Returns:

the output file name to be used when the TaskOutput is not a File output.

setOutputName

public void setOutputName(String outputName)

Parameters:

outputName - the outputName to be used when the output is not a file destination

addInput

public void addInput(PdfMergeInput input)

adds the given input to the list of inputs for the merge task.

Parameters:

input -

isCopyFormFields

public boolean isCopyFormFields()

isBlankPageIfOdd

public boolean isBlankPageIfOdd()

setBlankPageIfOdd

public void setBlankPageIfOdd(boolean blankPageIfOdd)

Setting this true tells the task to add a blank page after each merged document if the number of pages is odd. It can be useful to print the document double-sided.

Parameters:

blankPageIfOdd -

setCopyFormFields

public void setCopyFormFields(boolean copyFormFields)

Setting this true tells the task to try to merge form fields if any of the input document has forms.

Parameters:

copyFormFields -

getOutlinePolicy

public OutlinePolicy getOutlinePolicy()

setOutlinePolicy

public void setOutlinePolicy(OutlinePolicy outlinePolicy)

The policy that the merge task should use when handling the outline tree (bookmarks)

Parameters:

outlinePolicy -

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPdfOutputParameters

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractPdfOutputParameters