Module org.sejda.sambox

Package org.sejda.sambox.pdmodel.common.filespecification

Interface PDFileSpecification

All Superinterfaces:

COSObjectable

All Known Implementing Classes:

PDComplexFileSpecification, PDSimpleFileSpecification

public interface PDFileSpecification
extends COSObjectable

This represents a file specification.

Author:

Ben Litchfield

Method Summary

Modifier and Type	Method	Description
static PDFileSpecification	createFS(COSBase base)	A file specfication can either be a COSString or a COSDictionary.
String	getFile()
void	setFile(String file)

Methods inherited from interface org.sejda.sambox.cos.COSObjectable

getCOSObject

Method Details

createFS

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.

Throws:

IOException - If there is an error creating the file spec.

getFile

String getFile()

Returns:

The file name.

setFile

void setFile(String file)

Parameters:

file - The name of the file.