org.sejda.model.parameter.base

Class MultiplePdfSourceMultipleOutputParameters

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

All Implemented Interfaces:

MultiplePdfSourceTaskParameters, PrefixableTaskParameters, SingleOrMultipleOutputTaskParameters, TaskParameters

Direct Known Subclasses:

AbstractPdfToMultipleImageParameters, AbstractSplitByPageParameters, ExtractByOutlineParameters, ExtractPagesParameters, RotateParameters, SetMetadataParameters, SplitByOutlineLevelParameters, SplitBySizeParameters, ViewerPreferencesParameters

public class MultiplePdfSourceMultipleOutputParameters
extends MultiplePdfSourceParameters
implements SingleOrMultipleOutputTaskParameters

Provides a skeletal implementation for parameter classes having multiple pdf source as input and generating multiple output files. The output can be a file for scenarios where a the task produces one output file (eg: rotate on a single input)

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
MultiplePdfSourceMultipleOutputParameters()

Method Summary

Modifier and Type	Method and Description
void	addSpecificResultFilename(String filename)
void	addSpecificResultFilenames(Collection<String> filenames) Adds the given filenames to the list of the explicit filenames
boolean	equals(Object other)
SingleOrMultipleTaskOutput	getOutput()
String	getOutputPrefix()
String	getSpecificResultFilename(int fileNumber)
String	getSpecificResultFilename(int fileNumber, String expectedExtension)
List<String>	getSpecificResultFilenames()
int	hashCode()
void	setOutput(SingleOrMultipleTaskOutput output) Sets the output destination
void	setOutputPrefix(String outputPrefix) Set the prefix to be used to generate names of the multiple outputs for this parameter.

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, 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

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient

Constructor Detail

MultiplePdfSourceMultipleOutputParameters

public MultiplePdfSourceMultipleOutputParameters()

Method Detail

getOutputPrefix

public String getOutputPrefix()

Specified by:

getOutputPrefix in interface PrefixableTaskParameters

Returns:

the prefix to be used to generate names of the multiple outputs.

setOutputPrefix

public void setOutputPrefix(String outputPrefix)

Description copied from interface: PrefixableTaskParameters

Set the prefix to be used to generate names of the multiple outputs for this parameter.

Specified by:

setOutputPrefix in interface PrefixableTaskParameters

getOutput

public SingleOrMultipleTaskOutput getOutput()

Specified by:

getOutput in interface TaskParameters

Returns:

output destination where the result of the manipulation is placed

setOutput

public void setOutput(SingleOrMultipleTaskOutput output)

Description copied from interface: SingleOrMultipleOutputTaskParameters

Sets the output destination

Specified by:

setOutput in interface SingleOrMultipleOutputTaskParameters

addSpecificResultFilename

public void addSpecificResultFilename(String filename)

addSpecificResultFilenames

public void addSpecificResultFilenames(Collection<String> filenames)

Adds the given filenames to the list of the explicit filenames

Parameters:

filenames -

See Also:

ArrayList.addAll(Collection)

getSpecificResultFilenames

public List<String> getSpecificResultFilenames()

Returns:

the List of names explicitly set for the output files. The first file generated by the task will be named using the first element of this list, the second file using the second name and so on. If no valid name is found we fallback to the default names generation logic.

getSpecificResultFilename

public String getSpecificResultFilename(int fileNumber)

Parameters:

fileNumber -

Returns:

the explicit filename set for the given PDF output fileNumber or null if no valid filename is found. The resulting filename is sanitized to contain only valid characters and to have a PDF extension.

getSpecificResultFilename

public String getSpecificResultFilename(int fileNumber,
                                        String expectedExtension)

Parameters:

fileNumber -

expectedExtension - the expect extension (.pdf, .json, .txt).

Returns:

the explicit filename set for the given output fileNumber or null if no valid filename is found. The resulting filename is sanitized to contain only valid characters and to have the expected file extension.

hashCode

public int hashCode()

Overrides:

hashCode in class MultiplePdfSourceParameters

equals

public boolean equals(Object other)

Overrides:

equals in class MultiplePdfSourceParameters