Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| PDF Clown 0.1.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.pdfclown.files
Class FileIdentifier

    java.lang.Object
      org.pdfclown.objects.PdfObjectWrapper<PdfArray>
          org.pdfclown.files.FileIdentifier

All Implemented Interfaces:
  Cloneable, IPdfObjectWrapper

    public final class FileIdentifier

extends PdfObjectWrapper<PdfArray>

File identifier [PDF:1.7:10.3].

Since:
  0.1.2
Version:
  0.1.2, 12/21/12
Author:
  Stefano Chizzolini (http://www.stefanochizzolini.it)

Constructor Summary
`FileIdentifier()` Creates a new direct file identifier.
`FileIdentifier(File context)` Creates a new indirect file identifier.

Method Summary
`FileIdentifier` | `clone(Document context)` Gets a clone of the object, registered inside the given document context.
`String` | `getBaseID()` Gets the permanent identifier based on the contents of the file at the time it was originally created.
`String` | `getVersionID()` Gets the changing identifier based on the file's contents at the time it was last updated.
`void` | `update(Writer writer)` Computes a new version identifier based on the file's contents.
`static FileIdentifier` | `wrap(PdfDirectObject baseObject)` Gets an existing file identifier.

Methods inherited from class org.pdfclown.objects.PdfObjectWrapper
`checkCompatibility, delete, equals, exists, getBaseDataObject, getBaseObject, getBaseObject, getContainer, getDataContainer, getDocument, getFile, getMetadata, retrieveName, retrieveNamedBaseObject, setBaseObject, setMetadata`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### FileIdentifier

    public FileIdentifier()

  Creates a new direct file identifier.

### FileIdentifier

    public FileIdentifier(File context)

  Creates a new indirect file identifier.

Method Detail

### wrap

    public static FileIdentifier wrap(PdfDirectObject baseObject)

  Gets an existing file identifier.

  Parameters:
    `baseObject` - Base object to wrap.

### clone

    public FileIdentifier clone(Document context)

  Description copied from class: `PdfObjectWrapper`
  Gets a clone of the object, registered inside the given document context.

  Overrides:
    `clone` in class `PdfObjectWrapper<PdfArray>`
  Parameters:
    `context` - Which document the clone has to be registered in.

### getBaseID

    public String getBaseID()

  Gets the permanent identifier based on the contents of the file at the time it was originally created.

### getVersionID

    public String getVersionID()

  Gets the changing identifier based on the file's contents at the time it was last updated.

### update

    public void 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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| PDF Clown 0.1.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Project home page
Copyright © 2006-2013 Stefano Chizzolini. Some Rights Reserved.
This documentation is available under the terms of the GNU Free Documentation License.