eu.id3.bioseal

## Class Manifest

- java.lang.Object
- - eu.id3.bioseal.Manifest

- All Implemented Interfaces:
    java.io.Serializable, java.lang.AutoCloseable

      public class Manifest
      extends java.lang.Object
      implements java.lang.AutoCloseable, java.io.Serializable

  Provides information about the manifest.
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `Manifest()` Creates a new instance of the Manifest class.
    `Manifest(long handle)` Creates a new instance of the Manifest class.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` Releases all resources used by this Manifest.
    `protected void` | `finalize()` Finalizer for this class.
    `java.lang.String` | `getDocumentDescription(java.lang.String language)` Gets the description of the document.
    `java.lang.String` | `getDocumentName(java.lang.String language)` Gets the name of the document.
    `ExtensionList` | `getExtensionList()` Gets the the extension list.
    `long` | `getHandle()` Gets the native handle.
    `Log` | `getLog()` Gets the the log.
    `int` | `getManifestId()` Gets the the manifest ID in ISO 22385 format.
    `int` | `getManifestVersion()` Gets the the manifest version.
    `StringArray` | `getSupportedLanguages()` Gets the the list of supported languages declared in the manifest.
    `void` | `load(byte[] manifestData)` Loads the manifest.
    `void` | `loadFromFile(java.lang.String path)` Loads the manifest from file.
    `void` | `loadFromString(java.lang.String manifestData)` Loads the manifest.
    `void` | `setLog(Log log)` Sets the the log.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Manifest

          public Manifest()
                   throws BiosealException

      Creates a new instance of the Manifest class.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### Manifest

          public Manifest(long handle)
                   throws BiosealException

      Creates a new instance of the Manifest class.
      Parameters:
        `handle` - Handle to the Manifest.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

  - ### Method Detail

    - #### close

          public void close()

      Releases all resources used by this Manifest.
      Specified by:
        `close` in interface `java.lang.AutoCloseable`

    - #### finalize

          protected void finalize()

      Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.
      Overrides:
        `finalize` in class `java.lang.Object`

    - #### getHandle

          public long getHandle()

      Gets the native handle.
      Returns:
        The native handle.

    - #### getManifestId

          public int getManifestId()
                            throws BiosealException

      Gets the the manifest ID in ISO 22385 format.
      Returns:
        The manifest ID in ISO 22385 format.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getManifestVersion

          public int getManifestVersion()
                                 throws BiosealException

      Gets the the manifest version.
      Returns:
        The manifest version.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getSupportedLanguages

          public StringArray getSupportedLanguages()
                                            throws BiosealException

      Gets the the list of supported languages declared in the manifest.
      Returns:
        The list of supported languages declared in the manifest.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getExtensionList

          public ExtensionList getExtensionList()
                                         throws BiosealException

      Gets the the extension list.
      Returns:
        The extension list.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getLog

          public Log getLog()
                     throws BiosealException

      Gets the the log.
      Returns:
        The log.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### setLog

          public void setLog(Log log)
                      throws BiosealException

      Sets the the log.
      Parameters:
        `log` - The log.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### load

          public void load(byte[] manifestData)
                    throws BiosealException

      Loads the manifest.
      Parameters:
        `manifestData` - The manifest data.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### loadFromString

          public void loadFromString(java.lang.String manifestData)
                              throws BiosealException

      Loads the manifest.
      Parameters:
        `manifestData` - The manifest data.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### loadFromFile

          public void loadFromFile(java.lang.String path)
                            throws BiosealException

      Loads the manifest from file.
      Parameters:
        `path` - The manifest path.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getDocumentName

          public java.lang.String getDocumentName(java.lang.String language)
                                           throws BiosealException

      Gets the name of the document.
      Parameters:
        `language` - The expected language.
      Returns:
        The name of the document.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getDocumentDescription

          public java.lang.String getDocumentDescription(java.lang.String language)
                                                  throws BiosealException

      Gets the description of the document.
      Parameters:
        `language` - The expected language.
      Returns:
        The description of the document.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

Copyright © 2020-2030, id3 Technologies. All rights reserved. eu.id3.bioseal