eu.id3.bioseal

## Class Field

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

- All Implemented Interfaces:
    java.io.Serializable, java.lang.AutoCloseable, java.lang.Iterable<Field>

      public class Field
      extends java.lang.Object
      implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<Field>

  Represents a field or a dictionary of fields.
  See Also:
    Serialized Form

- - ### Constructor Summary

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

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` Releases all resources used by this Field.
    `boolean` | `containsBiometricData(BiometricDataType biometricDataType, java.lang.String biometricFormat)` Returns a value indicating whether the field (or one of its child fields) contains biometric data of the specified type and/or format.
    `boolean` | `containsExtension(FieldExtensionType extensionType)` Returns a value indicating whether the field (or one of its child fields) contains an extension of the specified type.
    `boolean` | `containsExtensionByName(java.lang.String extensionName)` Returns a value indicating whether the field (or one of its child fields) contains an extension with specified name.
    `boolean` | `containsKey(java.lang.String key)` Determines whether the Fieldobject contains the specified key.
    `protected void` | `finalize()` Finalizer for this class.
    `Field` | `get(java.lang.String key)` Gets an item of the Field object.
    `byte[]` | `getBinaryAtIndex(int index)` Gets the binary data at the specified index.
    `boolean` | `getContainsBiometrics()` Gets the A value indicating whether the field (or one of its child fields) contains biometric data.
    `int` | `getCount()` Gets the number of elements in the Field object.
    `FieldExtensionType` | `getExtensionType()` Gets the the field extension type.
    `Extension` | `getFieldExtension()` Gets the the field extension.
    `FieldType` | `getFieldType()` Gets the the field type.
    `long` | `getHandle()` Gets the native handle.
    `boolean` | `getIsNull()` Gets the A value indicating whether if the field is null.
    `StringArray` | `getKeys()` Gets the gets a string list containing the keys in the dict.
    `java.lang.String` | `getLocalizedLabel(java.lang.String language)` Retrieves the localized label based on the provided language code.
    `java.lang.String` | `getLocalizedValue(java.lang.String language)` Retrieves the localized value based on the provided language code.
    `java.lang.String` | `getName()` Gets the the field name.
    `Field` | `getObjectAtIndex(int index)` Gets the object at the specified index.
    `byte[]` | `getValueAsBinary()` Gets the the data as a binary array.
    `boolean` | `getValueAsBoolean()` Gets the the field value as a boolean.
    `boolean[]` | `getValueAsBooleanArray()` Gets the the field value as an array of booleans.
    `DateTime` | `getValueAsDate()` Gets the the field value as a date.
    `DateTime` | `getValueAsDateTime()` Gets the the field value as a date/time.
    `DateTimeArray` | `getValueAsDateTimeArray()` Gets the the field value as an array of dates.
    `float` | `getValueAsFloat()` Gets the the field value as a float.
    `float[]` | `getValueAsFloatArray()` Gets the the field value as an array of floats.
    `long` | `getValueAsInteger()` Gets the the field value as a 64-bit integer.
    `long[]` | `getValueAsIntegerArray()` Gets the the field value as an array of 64-bit integers.
    `java.lang.String` | `getValueAsString()` Gets the the field value as a string.
    `StringArray` | `getValueAsStringArray()` Gets the the field value as an array of strings.
    `DateTime` | `getValueAsTime()` Gets the the field value as a time.
    `long` | `getValueAsTimestamp()` Gets the the field value as a timestamp (without timezone computation).
    `long[]` | `getValueAsTimestampArray()` Gets the the field value as an array of timestamp.
    `VisibilityCondition` | `getVisibilityCondition()` Gets the the visibility condition.
    `java.util.Iterator<Field>` | `iterator()`
    `void` | `setTimeZoneOffset(int offsetInSeconds)` Set the time zone offset in seconds.

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

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

    - ### Methods inherited from interface java.lang.Iterable

      `forEach, spliterator`

- - ### Constructor Detail

    - #### Field

          public Field()
                throws BiosealException

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

    - #### Field

          public Field(long handle)
                throws BiosealException

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

  - ### Method Detail

    - #### close

          public void close()

      Releases all resources used by this Field.
      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.

    - #### getFieldType

          public FieldType getFieldType()
                                 throws BiosealException

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

    - #### getName

          public java.lang.String getName()
                                   throws BiosealException

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

    - #### getValueAsInteger

          public long getValueAsInteger()
                                 throws BiosealException

      Gets the the field value as a 64-bit integer.
      Returns:
        The field value as a 64-bit integer.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsBoolean

          public boolean getValueAsBoolean()
                                    throws BiosealException

      Gets the the field value as a boolean.
      Returns:
        The field value as a boolean.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsFloat

          public float getValueAsFloat()
                                throws BiosealException

      Gets the the field value as a float.
      Returns:
        The field value as a float.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsString

          public java.lang.String getValueAsString()
                                            throws BiosealException

      Gets the the field value as a string.
      Returns:
        The field value as a string.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsBinary

          public byte[] getValueAsBinary()
                                  throws BiosealException

      Gets the the data as a binary array.
      Returns:
        The data as a binary array.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsDate

          public DateTime getValueAsDate()
                                  throws BiosealException

      Gets the the field value as a date.
      Returns:
        The field value as a date.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsTime

          public DateTime getValueAsTime()
                                  throws BiosealException

      Gets the the field value as a time.
      Returns:
        The field value as a time.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsDateTime

          public DateTime getValueAsDateTime()
                                      throws BiosealException

      Gets the the field value as a date/time.
      Returns:
        The field value as a date/time.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsTimestamp

          public long getValueAsTimestamp()
                                   throws BiosealException

      Gets the the field value as a timestamp (without timezone computation).
      Returns:
        The field value as a timestamp (without timezone computation).
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsIntegerArray

          public long[] getValueAsIntegerArray()
                                        throws BiosealException

      Gets the the field value as an array of 64-bit integers.
      Returns:
        The field value as an array of 64-bit integers.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsBooleanArray

          public boolean[] getValueAsBooleanArray()
                                           throws BiosealException

      Gets the the field value as an array of booleans.
      Returns:
        The field value as an array of booleans.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsFloatArray

          public float[] getValueAsFloatArray()
                                       throws BiosealException

      Gets the the field value as an array of floats.
      Returns:
        The field value as an array of floats.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsStringArray

          public StringArray getValueAsStringArray()
                                            throws BiosealException

      Gets the the field value as an array of strings.
      Returns:
        The field value as an array of strings.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsDateTimeArray

          public DateTimeArray getValueAsDateTimeArray()
                                                throws BiosealException

      Gets the the field value as an array of dates.
      Returns:
        The field value as an array of dates.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getValueAsTimestampArray

          public long[] getValueAsTimestampArray()
                                          throws BiosealException

      Gets the the field value as an array of timestamp.
      Returns:
        The field value as an array of timestamp.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getIsNull

          public boolean getIsNull()
                            throws BiosealException

      Gets the A value indicating whether if the field is null.
      Returns:
        A value indicating whether if the field is null.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getContainsBiometrics

          public boolean getContainsBiometrics()
                                        throws BiosealException

      Gets the A value indicating whether the field (or one of its child fields) contains biometric data.
      Returns:
        A value indicating whether the field (or one of its child fields) contains biometric data.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getExtensionType

          public FieldExtensionType getExtensionType()
                                              throws BiosealException

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

    - #### getFieldExtension

          public Extension getFieldExtension()
                                      throws BiosealException

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

    - #### getVisibilityCondition

          public VisibilityCondition getVisibilityCondition()
                                                     throws BiosealException

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

    - #### getKeys

          public StringArray getKeys()
                              throws BiosealException

      Gets the gets a string list containing the keys in the dict.
      Returns:
        Gets a string list containing the keys in the dict.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### get

          public Field get(java.lang.String key)
                    throws BiosealException

      Gets an item of the Field object.
      Parameters:
        `key` - Unique key of the Field item to get.
      Returns:
        Field item to get.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getCount

          public int getCount()
                       throws BiosealException

      Gets the number of elements in the Field object.
      Returns:
        Number of elements in the Field object.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### containsKey

          public boolean containsKey(java.lang.String key)
                              throws BiosealException

      Determines whether the Fieldobject contains the specified key.
      Parameters:
        `key` - The key to locate in the Field object.
      Returns:
        true if the Field object contains an element with the specified key, otherwise false.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getObjectAtIndex

          public Field getObjectAtIndex(int index)
                                 throws BiosealException

      Gets the object at the specified index.
      Parameters:
        `index` - The index of the object to retrieve.
      Returns:
        The field that contains the object.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getBinaryAtIndex

          public byte[] getBinaryAtIndex(int index)
                                  throws BiosealException

      Gets the binary data at the specified index.
      Parameters:
        `index` - The index of the binary field to retrieve.
      Returns:
        The binary data.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### setTimeZoneOffset

          public void setTimeZoneOffset(int offsetInSeconds)
                                 throws BiosealException

      Set the time zone offset in seconds.
      Parameters:
        `offsetInSeconds` - The time zone offset in seconds.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### containsExtension

          public boolean containsExtension(FieldExtensionType extensionType)
                                    throws BiosealException

      Returns a value indicating whether the field (or one of its child fields) contains an extension of the specified type.
      Parameters:
        `extensionType` - The field extension type.
      Returns:
        A value indicating whether the field (or one of its child fields) contains the specified extension.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### containsExtensionByName

          public boolean containsExtensionByName(java.lang.String extensionName)
                                          throws BiosealException

      Returns a value indicating whether the field (or one of its child fields) contains an extension with specified name.
      Parameters:
        `extensionName` - A string that identifies the extension.
      Returns:
        A value indicating whether the field (or one of its child fields) contains the specified extension.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### containsBiometricData

          public boolean containsBiometricData(BiometricDataType biometricDataType,
                                               java.lang.String biometricFormat)
                                        throws BiosealException

      Returns a value indicating whether the field (or one of its child fields) contains biometric data of the specified type and/or format.
      Parameters:
        `biometricDataType` - The biometric data type.
        `biometricFormat` - The biometric data format.
      Returns:
        A value indicating whether the field (or one of its child fields) contains biometric data of the specified type and/or format.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getLocalizedLabel

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

      Retrieves the localized label based on the provided language code.
      Parameters:
        `language` - The language code for which the label should be localized (e.g., 'en' for English, 'fr' for French).
      Returns:
        The localized label corresponding to the provided language code.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### getLocalizedValue

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

      Retrieves the localized value based on the provided language code.
      Parameters:
        `language` - The language code for which the value should be localized (e.g., 'en' for English, 'fr' for French).
      Returns:
        The localized value corresponding to the provided language code.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### iterator

          public java.util.Iterator<Field> iterator()

      Specified by:
        `iterator` in interface `java.lang.Iterable<Field>`

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