org.pdfbox.pdmodel.common.filespecification

Class PDFileSpecification

Implemented Interfaces:
COSObjectable
Known Direct Subclasses:
PDComplexFileSpecification, PDSimpleFileSpecification

public abstract class PDFileSpecification
extends java.lang.Object
implements COSObjectable

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

Method Summary

static PDFileSpecification
createFS(COSBase base)
A file specfication can either be a COSString or a COSDictionary.
abstract String
getFile()
This will get the file name.
abstract void
setFile(String file)
This will set the file name.

Method Details

createFS

public static PDFileSpecification createFS(COSBase base)
            throws IOException
A file specfication can either be a COSString or a COSDictionary. This will create the file specification either way.
Parameters:
base - The cos object that describes the fs.
Returns:
The file specification for the COSBase object.

getFile

public abstract String getFile()
This will get the file name.
Returns:
The file name.

setFile

public abstract void setFile(String file)
This will set the file name.
Parameters:
file - The name of the file.