Class PDFileSpecification

java.lang.Object
org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
All Implemented Interfaces:
COSObjectable
Direct Known Subclasses:
PDComplexFileSpecification, PDSimpleFileSpecification

public abstract class PDFileSpecification extends Object implements COSObjectable
This represents a file specification.
  • Constructor Details

    • PDFileSpecification

      public PDFileSpecification()
  • Method Details

    • createFS

      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 - 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

      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.