com.qoppa.pdf

Interface IEmbeddedFile

public interface IEmbeddedFile

Representation of an embedded file in a PDF document. This interface defines the methods that can be used on an embedded file.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
byte[]	getCheckSum() Get the 16-byte string that is the checksum of the bytes of the uncompressed embedded file.
Date	getCreationDate() The date and time when the embedded file was created.
byte[]	getDeflatedContents() Get the content of the embedded file, deflated.
String	getDescription() Returns the description string from the embedded file.
String	getFileName() Returns the embedded file name.
InputStream	getInputStream() Returns an input stream from which the file contents can be read.
Date	getModDate() The date and time when the embedded file was last modified.
String	getRelationship() Returns the relationship of the embedded file to the PDF document.
int	getSize() Get the size of the file content in bytes.
void	saveFile(File outFile) Saves the content of the embedded file to the given output file.
void	write(OutputStream outStream) Write the file content to an output stream.

Method Detail

getFileName

String getFileName()

Returns the embedded file name.

Returns:

the file name.

saveFile

void saveFile(File outFile)
       throws IOException,
              PDFException

Saves the content of the embedded file to the given output file.

Parameters:

outFile - the file to save to.

Throws:

IOException

PDFException

getDeflatedContents

byte[] getDeflatedContents()
                    throws PDFException,
                           IOException

Get the content of the embedded file, deflated.

Returns:

the content bytes array.

Throws:

PDFException

IOException

getSize

int getSize()
     throws IOException,
            PDFException

Get the size of the file content in bytes.

Returns:

the size.

Throws:

IOException

PDFException

getCheckSum

byte[] getCheckSum()
            throws PDFException,
                   IOException

Get the 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm.

Returns:

the checksum of the file.

Throws:

PDFException

IOException

getCreationDate

Date getCreationDate()

The date and time when the embedded file was created.

Returns:

the date and time when the embedded file was created.

getModDate

Date getModDate()

The date and time when the embedded file was last modified.

Returns:

The date and time when the embedded file was last modified.

getDescription

String getDescription()

Returns the description string from the embedded file.

getRelationship

String getRelationship()

Returns the relationship of the embedded file to the PDF document.

write

void write(OutputStream outStream)
    throws IOException,
           PDFException

Write the file content to an output stream.

Parameters:

outStream - the output stream.

Throws:

IOException

PDFException

getInputStream

InputStream getInputStream()
                    throws PDFException,
                           IOException

Returns an input stream from which the file contents can be read.

Returns:

Input stream to read file contents

Throws:

PDFException

IOException