Top Description Constructors Methods
org.apache.pdfbox.pdmodel.common.filespecification

public abstract Class PDFileSpecification

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Known Direct Subclasses
org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification, org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Imports
java.io.IOException, org.apache.pdfbox.cos.COSBase, .COSDictionary, .COSString, org.apache.pdfbox.pdmodel.common.COSObjectable

This represents a file specification.
Author
Ben Litchfield

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static PDFileSpecification

Returns:

The file specification for the COSBase object.
createFS
(COSBase
The cos object that describes the fs.
base
)

A file specification can either be a COSString or a COSDictionary.

public abstract String

Returns:

The file name.
getFile
()

This will get the file name.

public abstract void
setFile(String
The name of the file.
file
)

This will set the file name.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

PDFileSpecificationback to summary
public PDFileSpecification()

Method Detail

createFSback to summary
public static PDFileSpecification createFS(COSBase base) throws IOException

A file specification can either be a COSString or a COSDictionary. This will create the file specification either way.

Parameters
base:COSBase

The cos object that describes the fs.

Returns:PDFileSpecification

The file specification for the COSBase object.

Exceptions
IOException:
If there is an error creating the file spec.
getFileback to summary
public abstract String getFile()

This will get the file name.

Returns:String

The file name.

setFileback to summary
public abstract void setFile(String file)

This will set the file name.

Parameters
file:String

The name of the file.