Summary: Ctors | Methods | Inherited Methods | [Expand All]
public class

# FileSpec

extends Object

java.lang.Object
↳ | com.pdftron.pdf.FileSpec

## Class Overview

FileSpec corresponds to the PDF file specification object.

A PDF file can refer to the contents of another file by using a file specification, which can take either of the following forms:

1. A simple file specification gives just the name of the target file in a standard format, independent of the naming conventions of any particular file system.
2. A full file specification includes information related to one or more specific file systems.
3. A URL reference.

Although the file designated by a file specification is normally external to the PDF file referring to it, it is also possible to embed the file allowing its contents to be stored or transmitted along with the PDF file. However, embedding a file does not change the presumption that it is external to (or separate from) the PDF file.

For more details on file specifications, please refer to Section 3.10, 'File Specifications' in the PDF Reference Manual.

## Summary

Public Constructors
| FileSpec(Obj f) Create a FileSpec and initialize it using given Cos/SDF object.

Public Methods
static FileSpec | __Create(long impl, Object ref)
long | __GetHandle()
Object | __GetRefHandle()
static FileSpec | create(Doc doc, String path) Creates a file specification for the given file.
static FileSpec | create(Doc doc, String path, boolean embed) Creates a file specification for the given file.
static FileSpec | createURL(Doc doc, String url) Creates a URL file specification.
boolean | equals(Object d) Compares two FileSpec-s for equality.
boolean | export() The function saves the data referenced by this FileSpec to an external file.
boolean | export(String save_as) The function saves the data referenced by this FileSpec to an external file.
Filter | getFileData() The function returns data referenced by this FileSpec.
String | getFilePath() Get the file path.
Obj | getSDFObj() Get the SDFObj.
int | hashCode()
boolean | isValid() Checks if current FileSpec is valid.
void | setDesc(String desc) The functions sets the descriptive text associated with the file specification.

[Expand] Inherited Methods
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Public Constructors

#### public FileSpec (Obj f)

Create a FileSpec and initialize it using given Cos/SDF object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

##### Parameters

f | the given Cos/SDF object

## Public Methods

#### public static FileSpec __Create (long impl, Object ref)

#### public long __GetHandle ()

#### public Object __GetRefHandle ()

#### public static FileSpec create (Doc doc, String path)

Creates a file specification for the given file. The specified file is embedded in PDF.

##### Parameters

doc | A document to which the FileSpec should be added. To obtain SDFDoc from PDFDoc use PDFDoc::GetSDFDoc() or Obj::GetDoc().
path | The path to convert into a file specification.

##### Returns

- newly created FileSpec object.

##### Throws

PDFNetException |

#### public static FileSpec create (Doc doc, String path, boolean embed)

Creates a file specification for the given file.

##### Parameters

doc | A document to which the FileSpec should be added. To obtain SDFDoc from PDFDoc use PDFDoc.GetSDFDoc or Obj.GetDoc.
path | The path to convert into a file specification.
embed | A flag indicating whether to embed specified in the PDF. By default, all files are embedded.

##### Returns

- the newly created FileSpec object

##### Throws

PDFNetException |

#### public static FileSpec createURL (Doc doc, String url)

Creates a URL file specification.

##### Parameters

doc | - A document to which the FileSpec should be added. To obtain SDF::Doc from PDFDoc use PDFDoc::GetSDFDoc() or Obj::GetDoc().
url | - A uniform resource locator (URL) of the form defined in Internet RFC 1738, Uniform Resource Locators Specification.

##### Returns

- newly created FileSpec object.

##### Throws

PDFNetException |

#### public boolean equals (Object d)

Compares two FileSpec-s for equality. The comparison will return true only if both annotations share the same underlying SDF/Cos object.

##### Parameters

d | the d

##### Returns

- true, if successful

#### public boolean export ()

The function saves the data referenced by this FileSpec to an external file.

##### Returns

- true is the file was saved successfully, false otherwise.

##### Throws

PDFNetException |

#### public boolean export (String save_as)

The function saves the data referenced by this FileSpec to an external file.

##### Parameters

save_as | An optional parameter indicating the filepath and filename where the data should be saved. If this parameter is not specified, the function will attempt to save the file using FileSpec.GetFilePath().

##### Returns

- true, if successful

##### Throws

PDFNetException |

#### public Filter getFileData ()

The function returns data referenced by this FileSpec.

##### Returns

- A stream (filter) containing file data. If the file is embedded, the function returns a stream to the embedded file. If the file is not embedded, the function will return a stream to the external file. If the file is not embedded and the external file can't be found, the function returns NULL.

##### Throws

PDFNetException |

#### public String getFilePath ()

Get the file path.

##### Returns

- The file path for this file specification. If the FileSpec is a dictionary, a corresponding platform specific path is returned (DOS, Mac, or Unix). Otherwise the function returns the path represented in the form described in Section 3.10.1, 'File Specification Strings,' or , if the file system is URL, as a uniform resource locator (URL). If the FileSpec is not valid, an empty string is returned.

##### Throws

PDFNetException |

#### public Obj getSDFObj ()

Get the SDFObj.

##### Returns

- The underlying SDF/Cos object.

#### public int hashCode ()

#### public boolean isValid ()

Checks if current FileSpec is valid.

##### Returns

- whether this is a valid (non-null) FileSpec. If the function returns false the underlying SDF/Cos object is null or is not valid and the FileSpec object should be treated as null as well.

##### Throws

PDFNetException |

#### public void setDesc (String desc)

The functions sets the descriptive text associated with the file specification. This test is typically used in the EmbeddedFiles name tree.

##### Parameters

desc | the new description

##### Throws

PDFNetException |