org.pdfbox.pdmodel.common.filespecification

Class PDComplexFileSpecification

Implemented Interfaces:
COSObjectable

public class PDComplexFileSpecification
extends PDFileSpecification

This represents a file specification.
Version:
$Revision: 1.4 $
Author:
Ben Litchfield

Constructor Summary

PDComplexFileSpecification()
Default Constructor.
PDComplexFileSpecification(COSDictionary dict)
Constructor.

Method Summary

COSDictionary
getCOSDictionary()
Convert this standard java object to a COS object.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
PDEmbeddedFile
getEmbeddedFile()
Get the embedded file.
PDEmbeddedFile
getEmbeddedFileDos()
Get the embedded dos file.
PDEmbeddedFile
getEmbeddedFileMac()
Get the embedded Mac file.
PDEmbeddedFile
getEmbeddedFileUnix()
Get the embedded Unix file.
String
getFile()
This will get the file name.
String
getFileDos()
This will get the name representing a Dos file.
String
getFileMac()
This will get the name representing a Mac file.
String
getFileUnix()
This will get the name representing a Unix file.
boolean
isVolatile()
Get if the file is volatile.
void
setEmbeddedFile(PDEmbeddedFile file)
Set the embedded file for this spec.
void
setEmbeddedFileDos(PDEmbeddedFile file)
Set the embedded dos file for this spec.
void
setEmbeddedFileMac(PDEmbeddedFile file)
Set the embedded Mac file for this spec.
void
setEmbeddedFileUnix(PDEmbeddedFile file)
Set the embedded Unix file for this spec.
void
setFile(String file)
This will set the file name.
void
setFileDos(String file)
This will set name representing a dos file.
void
setFileMac(String file)
This will set name representing a Mac file.
void
setFileUnix(String file)
This will set name representing a Unix file.
void
setVolatile(boolean fileIsVolatile)
Tell if the underlying file is volatile and should not be cached by the reader application.

Methods inherited from class org.pdfbox.pdmodel.common.filespecification.PDFileSpecification

createFS, getFile, setFile

Constructor Details

PDComplexFileSpecification

public PDComplexFileSpecification()
Default Constructor.

PDComplexFileSpecification

public PDComplexFileSpecification(COSDictionary dict)
Constructor.
Parameters:
dict - The dictionary that fulfils this file specification.

Method Details

getCOSDictionary

public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
Returns:
The cos object that matches this Java object.

getCOSObject

public COSBase getCOSObject()
Convert this standard java object to a COS object.
Specified by:
getCOSObject in interface COSObjectable
Returns:
The cos object that matches this Java object.

getEmbeddedFile

public PDEmbeddedFile getEmbeddedFile()
Get the embedded file.
Returns:
The embedded file for this file spec.

getEmbeddedFileDos

public PDEmbeddedFile getEmbeddedFileDos()
Get the embedded dos file.
Returns:
The embedded file for this file spec.

getEmbeddedFileMac

public PDEmbeddedFile getEmbeddedFileMac()
Get the embedded Mac file.
Returns:
The embedded file for this file spec.

getEmbeddedFileUnix

public PDEmbeddedFile getEmbeddedFileUnix()
Get the embedded Unix file.
Returns:
The embedded file for this file spec.

getFile

public String getFile()
This will get the file name.
Overrides:
getFile in interface PDFileSpecification
Returns:
The file name.

getFileDos

public String getFileDos()
This will get the name representing a Dos file.
Returns:
The file name.

getFileMac

public String getFileMac()
This will get the name representing a Mac file.
Returns:
The file name.

getFileUnix

public String getFileUnix()
This will get the name representing a Unix file.
Returns:
The file name.

isVolatile

public boolean isVolatile()
Get if the file is volatile. Default: false
Returns:
True if the file is volatile attribute is set.

setEmbeddedFile

public void setEmbeddedFile(PDEmbeddedFile file)
Set the embedded file for this spec.
Parameters:
file - The file to be embedded.

setEmbeddedFileDos

public void setEmbeddedFileDos(PDEmbeddedFile file)
Set the embedded dos file for this spec.
Parameters:
file - The dos file to be embedded.

setEmbeddedFileMac

public void setEmbeddedFileMac(PDEmbeddedFile file)
Set the embedded Mac file for this spec.
Parameters:
file - The Mac file to be embedded.

setEmbeddedFileUnix

public void setEmbeddedFileUnix(PDEmbeddedFile file)
Set the embedded Unix file for this spec.
Parameters:
file - The Unix file to be embedded.

setFile

public void setFile(String file)
This will set the file name.
Overrides:
setFile in interface PDFileSpecification
Parameters:
file - The name of the file.

setFileDos

public void setFileDos(String file)
This will set name representing a dos file.
Parameters:
file - The name of the file.

setFileMac

public void setFileMac(String file)
This will set name representing a Mac file.
Parameters:
file - The name of the file.

setFileUnix

public void setFileUnix(String file)
This will set name representing a Unix file.
Parameters:
file - The name of the file.

setVolatile

public void setVolatile(boolean fileIsVolatile)
Tell if the underlying file is volatile and should not be cached by the reader application. Default: false
Parameters:
fileIsVolatile - The new value for the volatility of the file.