org.pdfbox.pdmodel.common.filespecification

Class PDSimpleFileSpecification

Implemented Interfaces:
COSObjectable

public class PDSimpleFileSpecification
extends PDFileSpecification

A file specification that is just a string.
Version:
$Revision: 1.2 $
Author:
Ben Litchfield

Constructor Summary

PDSimpleFileSpecification()
Constructor.
PDSimpleFileSpecification(COSString fileName)
Constructor.

Method Summary

COSBase
getCOSObject()
Convert this standard java object to a COS object.
String
getFile()
This will get the file name.
void
setFile(String fileName)
This will set the file name.

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

createFS, getFile, setFile

Constructor Details

PDSimpleFileSpecification

public PDSimpleFileSpecification()
Constructor.

PDSimpleFileSpecification

public PDSimpleFileSpecification(COSString fileName)
Constructor.
Parameters:
fileName - The file that this spec represents.

Method Details

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.

getFile

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

setFile

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