cz.hobrasoft.pdfmu.operation.args

Class OutPdfArgs

java.lang.Object

cz.hobrasoft.pdfmu.operation.args.OutPdfArgs

All Implemented Interfaces:

ArgsConfiguration, AutoCloseable

public class OutPdfArgs
extends Object
implements ArgsConfiguration, AutoCloseable

The methods must be called in the following order:

1. addArguments(ArgumentParser)
2. setFromNamespace(Namespace)
3. setDefaultFile(File) (optional)
4. open(PdfReader, boolean, char)
5. close()

Author:

Filip Bartek

Constructor Summary

Constructors

Constructor and Description
OutPdfArgs(String metavarIn, boolean allowAppend)

Method Summary

Modifier and Type	Method and Description
void	addArguments(ArgumentParser parser) Adds arguments that configure this ArgsConfiguration to an ArgumentParser
void	close() Writes the content of the internal buffer to the output file.
void	close(boolean success)
File	getFile()
com.itextpdf.text.pdf.PdfStamper	getPdfStamper()
com.itextpdf.text.pdf.PdfStamper	open(com.itextpdf.text.pdf.PdfReader pdfReader, boolean signature, char pdfVersion) Returns a PdfStamper associated with the internal buffer.
void	setDefaultFile(File file) Set the target file if it has not been set by setFromNamespace(Namespace).
void	setFromNamespace(Namespace namespace) Sets configuration values from a parsed Namespace

Methods inherited from class java.lang.Object

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

Constructor Detail

OutPdfArgs

public OutPdfArgs(String metavarIn,
                  boolean allowAppend)

Method Detail

addArguments

public void addArguments(ArgumentParser parser)

Description copied from interface: ArgsConfiguration

Adds arguments that configure this ArgsConfiguration to an ArgumentParser

Specified by:

addArguments in interface ArgsConfiguration

Parameters:

parser - argument parser to add arguments to

setFromNamespace

public void setFromNamespace(Namespace namespace)

Description copied from interface: ArgsConfiguration

Sets configuration values from a parsed Namespace

Specified by:

setFromNamespace in interface ArgsConfiguration

Parameters:

namespace - the namespace with the argument values

setDefaultFile

public void setDefaultFile(File file)

Set the target file if it has not been set by setFromNamespace(Namespace).

Parameters:

file - the default file to be used in case none was specified by setFromNamespace(Namespace)

open

public com.itextpdf.text.pdf.PdfStamper open(com.itextpdf.text.pdf.PdfReader pdfReader,
                                             boolean signature,
                                             char pdfVersion)
                                      throws OperationException

Returns a PdfStamper associated with the internal buffer. Using a buffer instead of an actual file means that the operation can be rolled back completely, leaving the output file untouched. Call close() to save the content of the buffer to the output file.

Parameters:

pdfReader - the input PdfReader to operate on

signature - shall we be signing the document?

pdfVersion - the last character of the PDF version number ('2' to '7'), or '\0' to keep the original version

Returns:

a PdfStamper that uses pdfReader as the source

Throws:

OperationException - if an error occurs

close

public void close()
           throws OperationException

Writes the content of the internal buffer to the output file.

Specified by:

close in interface AutoCloseable

Throws:

OperationException - if an error occurs when closing the PdfStamper or when writing to the output file

close

public void close(boolean success)
           throws OperationException

Throws:

OperationException

getPdfStamper

public com.itextpdf.text.pdf.PdfStamper getPdfStamper()

getFile

public File getFile()