com.gnostice.documents.pdf

Class PDFFileAttachment

java.lang.Object

com.gnostice.documents.pdf.PDFFileAttachment

All Implemented Interfaces:

Cloneable

public final class PDFFileAttachment
extends Object
implements Cloneable

This class represents a file attachement that can be added to a PDF document.

Constructor Summary

Constructors

Constructor and Description
PDFFileAttachment(String filePath) Constructs an attachment with specified file.
PDFFileAttachment(String filePath, boolean compressAttachmentStream)
PDFFileAttachment(String attachmentName, byte[] byteArray) Constructs an attachment with specified byte array.
PDFFileAttachment(String attachmentName, byte[] byteArray, boolean compressAttachmentStream)

Method Summary

Modifier and Type	Method and Description
Object	clone()
String	getAttachmentDescription()
Date	getFileModifiedDate()
String	getFileName()
byte[]	getStream() Returns a byte array containing the attachment file.
void	setAttachmentDescription(String attachmentDescription)
void	setFileModifiedDate(Date fileModifiedDate)
void	setFileName(String fileName)
void	write(PDF doc)

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFFileAttachment

public PDFFileAttachment(String filePath)
                  throws IOException,
                         PDFException

Constructs an attachment with specified file.

Parameters:

filePath - pathname of the file

Throws:

IOException - if an I/O error occurs.

PDFException - if an illegal argument is supplied.

PDFFileAttachment

public PDFFileAttachment(String filePath,
                         boolean compressAttachmentStream)
                  throws IOException,
                         PDFException

Throws:

IOException

PDFException

PDFFileAttachment

public PDFFileAttachment(String attachmentName,
                         byte[] byteArray)
                  throws IOException,
                         PDFException

Constructs an attachment with specified byte array.

Parameters:

attachmentName - name that needs to be used for the attachment in the document

byteArray - byte array containing the attachment file

Throws:

IOException - if an I/O error occurs.

PDFException - if an illegal argument is supplied.

PDFFileAttachment

public PDFFileAttachment(String attachmentName,
                         byte[] byteArray,
                         boolean compressAttachmentStream)
                  throws IOException,
                         PDFException

Throws:

IOException

PDFException

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

getStream

public byte[] getStream()

Returns a byte array containing the attachment file.

Returns:

a byte array containing the attachment file

write

public void write(PDF doc)
           throws IOException

Throws:

IOException

getFileName

public String getFileName()

setFileName

public void setFileName(String fileName)

getFileModifiedDate

public Date getFileModifiedDate()

setFileModifiedDate

public void setFileModifiedDate(Date fileModifiedDate)

getAttachmentDescription

public String getAttachmentDescription()

setAttachmentDescription

public void setAttachmentDescription(String attachmentDescription)