org.pdfclown.files.FileIdentifier Class Reference
File identifier [PDF:1.7:10.3]. More...
Public Member Functions | |
| virtual object | Clone (Document context) |
| Gets a clone of the object, registered inside the given document context. | |
| virtual bool | Delete () |
| Removes the object from its document context. | |
| override bool | Equals (object obj) |
| FileIdentifier (File context) | |
| Creates a new indirect file identifier. | |
| FileIdentifier () | |
| Creates a new direct file identifier. | |
| override int | GetHashCode () |
| void | Update (Writer writer) |
| Computes a new version identifier based on the file's contents. | |
Static Public Member Functions | |
| static PdfDirectObject | GetBaseObject (PdfObjectWrapper wrapper) |
| Gets the PDF object backing the specified wrapper. | |
| static FileIdentifier | Wrap (PdfDirectObject baseObject) |
| Gets an existing file identifier. | |
Protected Member Functions | |
| void | CheckCompatibility (object feature) |
| Checks whether the specified feature is compatible with the document's conformance version. | |
| virtual PdfString | RetrieveName () |
| Retrieves the name possibly associated to this object, walking through the document's name dictionary. | |
| PdfDirectObject | RetrieveNamedBaseObject () |
| Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject. | |
Properties | |
| string | BaseID [get] |
| Gets the permanent identifier based on the contents of the file at the time it was originally created. | |
| virtual PdfDirectObject | BaseObject [get, set] |
| PdfIndirectObject | Container [get] |
| Gets the indirect object containing the base object. | |
| PdfIndirectObject | DataContainer [get] |
| Gets the indirect object containing the base data object. | |
| Document | Document [get] |
| Gets the document context. | |
| File | File [get] |
| Gets the file context. | |
| string | VersionID [get] |
| Gets the changing identifier based on the file's contents at the time it was last updated. | |
File identifier [PDF:1.7:10.3].
Constructor & Destructor Documentation
| org.pdfclown.files.FileIdentifier.FileIdentifier | ( | ) |
Creates a new direct file identifier.
| org.pdfclown.files.FileIdentifier.FileIdentifier | ( | File | context | ) |
Creates a new indirect file identifier.
Member Function Documentation
| void org.pdfclown.objects.PdfObjectWrapper.CheckCompatibility | ( | object | feature | ) | [protected, inherited] |
Checks whether the specified feature is compatible with the document's conformance version.
- Parameters:
-
feature Entity whose compatibility has to be checked. Supported types: - VersionEnum
- Property name resolvable to an annotated getter method
- MemberInfo
| virtual object org.pdfclown.objects.PdfObjectWrapper.Clone | ( | Document | context | ) | [virtual, inherited] |
Gets a clone of the object, registered inside the given document context.
- Parameters:
-
context Which document the clone has to be registered in.
| virtual bool org.pdfclown.objects.PdfObjectWrapper.Delete | ( | ) | [virtual, inherited] |
Removes the object from its document context.
The object is no more usable after this method returns.
- Returns:
- Whether the object was actually decontextualized (only indirect objects can be decontextualize).
| override bool org.pdfclown.objects.PdfObjectWrapper.Equals | ( | object | obj | ) | [inherited] |
| static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject | ( | PdfObjectWrapper< PdfArray > | wrapper | ) | [static, inherited] |
Gets the PDF object backing the specified wrapper.
- Parameters:
-
wrapper Object to extract the base from.
| override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode | ( | ) | [inherited] |
| virtual PdfString org.pdfclown.objects.PdfObjectWrapper.RetrieveName | ( | ) | [protected, virtual, inherited] |
Retrieves the name possibly associated to this object, walking through the document's name dictionary.
| PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject | ( | ) | [protected, inherited] |
Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
| void org.pdfclown.files.FileIdentifier.Update | ( | Writer | writer | ) |
Computes a new version identifier based on the file's contents.
This method is typically invoked internally during file serialization.
- Parameters:
-
writer File serializer.
References org.pdfclown.files.File.Document, org.pdfclown.tokens.Writer.File, org.pdfclown.documents.Document.Information, org.pdfclown.files.File.Path, and org.pdfclown.tokens.Writer.Stream.
Referenced by org.pdfclown.tokens.Writer.UpdateTrailer().
| static FileIdentifier org.pdfclown.files.FileIdentifier.Wrap | ( | PdfDirectObject | baseObject | ) | [static] |
Gets an existing file identifier.
- Parameters:
-
baseObject Base object to wrap.
Property Documentation
string org.pdfclown.files.FileIdentifier.BaseID [get] |
Gets the permanent identifier based on the contents of the file at the time it was originally created.
virtual PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.BaseObject [get, set, inherited] |
Gets the underlying reference object, if available; otherwise, gets the underlying data object.
PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container [get, inherited] |
Gets the indirect object containing the base object.
PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer [get, inherited] |
Gets the indirect object containing the base data object.
Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited] |
Gets the document context.
File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited] |
Gets the file context.
string org.pdfclown.files.FileIdentifier.VersionID [get] |
Gets the changing identifier based on the file's contents at the time it was last updated.
