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

public Class PDSimpleFileSpecification

extends PDFileSpecification
Class Inheritance
Imports
org.apache.pdfbox.cos.COSBase, .COSString
A file specification that is just a string.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private COSString
file

Constructor Summary

AccessConstructor and Description
public
PDSimpleFileSpecification()

Constructor.

public
PDSimpleFileSpecification(COSString
The file that this spec represents.
fileName)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public COSBase

Returns:

The cos object that matches this Java object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public String

Returns:

The file name.
getFile()

Implements abstract org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification.getFile.

This will get the file name.

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

Implements abstract org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification.setFile.

This will set the file name.

Inherited from org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification:
createFS

Field Detail

fileback to summary
private COSString file

Constructor Detail

PDSimpleFileSpecificationback to summary
public PDSimpleFileSpecification()

Constructor.

PDSimpleFileSpecificationback to summary
public PDSimpleFileSpecification(COSString fileName)

Constructor.

Parameters
fileName:COSString

The file that this spec represents.

Method Detail

getCOSObjectback to summary
public COSBase getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSBase

The cos object that matches this Java object.

Annotations
@Override
getFileback to summary
public String getFile()

Implements abstract org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification.getFile.

This will get the file name.

Returns:String

The file name.

Annotations
@Override
setFileback to summary
public void setFile(String fileName)

Implements abstract org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification.setFile.

This will set the file name.

Parameters
fileName:String

The name of the file.

Annotations
@Override