org.icepdf.core.pobjects.actions
Class FileSpecification

java.lang.Object
  org.icepdf.core.pobjects.Dictionary
      org.icepdf.core.pobjects.actions.FileSpecification

public class FileSpecification
extends Dictionary

The File Specification diction provides more flexibility then the string form. allowing different files to be specified for different file systems or platforms, or for file system othere than the standard ones (DOS/Windows, Mac OS, and Unix).

Since:

2.6

Author:

ICEsoft Technologies, Inc.

Field Summary

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, inited, isDeleted, isNew, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

FileSpecification(Library l, java.util.Hashtable h)
Constructs a new specification dictionary.

Method Summary

java.lang.String	getDescription() Gets the descriptive text associated with the file specification.
java.lang.String	getDos() Gets the file specification string representing a DOS file name.
java.util.Hashtable	getEmbeddedFileDictionary() Gets a dictionary containing a subset of the keys F, DOS, Mac, and Unix.
java.lang.String	getFileSpecification() Gets the file specification string.
java.lang.String	getFileSystemName() Gets the name of the file system to be used to interpret this file specification.
java.lang.String	getId() Gets an array of two strings constituting a file identifier that is also included in the referenced file.
java.lang.String	getMac() Gets the file specification string representing a Mac file name.
java.util.Hashtable	getRelatedFilesDictionary() Gets a dictionary with the same structure as the EF dectionary, which must also b present.
java.lang.String	getType() The type of the PDF object that this dictionary describes which is always "Filespec".
java.lang.String	getUnix() Gets the file specification string representing a Unix file name.
java.lang.Boolean	isVolitile() Returns a flag indicating whether the file referenced by the file specification is volatile (changes frequently with time).

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileSpecification

public FileSpecification(Library l,
                         java.util.Hashtable h)

Constructs a new specification dictionary.

Parameters:

l - document library.

h - dictionary entries.

Method Detail

getType

public java.lang.String getType()

The type of the PDF object that this dictionary describes which is always "Filespec".

Returns:

type of PDF object, "Filespec".

getFileSystemName

public java.lang.String getFileSystemName()

Gets the name of the file system to be used to interpret this file specification. This entry is independent of the F, DOS, Mac and Unix entries.

Returns:

the name of the file system to be used to interpret this file.

getFileSpecification

public java.lang.String getFileSpecification()

Gets the file specification string.

Returns:

file specification string.

getDos

public java.lang.String getDos()

Gets the file specification string representing a DOS file name.

Returns:

DOS file name.

getMac

public java.lang.String getMac()

Gets the file specification string representing a Mac file name.

Returns:

Mac file name.

getUnix

public java.lang.String getUnix()

Gets the file specification string representing a Unix file name.

Returns:

Unix file name.

getId

public java.lang.String getId()

Gets an array of two strings constituting a file identifier that is also included in the referenced file.

Returns:

file identifier.

isVolitile

public java.lang.Boolean isVolitile()

Returns a flag indicating whether the file referenced by the file specification is volatile (changes frequently with time).

Returns:

true indicates the file is volitile and should not be cached, otherwise true.

getEmbeddedFileDictionary

public java.util.Hashtable getEmbeddedFileDictionary()

Gets a dictionary containing a subset of the keys F, DOS, Mac, and Unix. The value of each key is an embedded file stream.

Returns:

embbed file stream properties.

getRelatedFilesDictionary

public java.util.Hashtable getRelatedFilesDictionary()

Gets a dictionary with the same structure as the EF dectionary, which must also b present. EAch key in the RF dictionary must also be present in the EF diciontary. Each value is a related file array identifying files that a re related to the corresponding file in the EF dictionary.

Returns:

related files dictionary.

getDescription

public java.lang.String getDescription()

Gets the descriptive text associated with the file specification.

Returns:

file identifier.