eu.id3.bioseal

## Class StringArray

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

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

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

  Represents an array of strings.
  See Also:
    Serialized Form

- - ### Constructor Summary

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

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` Releases all resources used by this StringArray.
    `boolean` | `contains(java.lang.String item)` Returns a value indicating whether a specified string occurs in this string array.
    `protected void` | `finalize()` Finalizer for this class.
    `java.lang.String` | `get(int index)` Gets an item of the StringArray object.
    `int` | `getCount()` Gets the number of elements in the StringArray object.
    `long` | `getHandle()` Gets the native handle.
    `java.util.Iterator<java.lang.String>` | `iterator()`

    - ### 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

    - #### StringArray

          public StringArray()
                      throws BiosealException

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

    - #### StringArray

          public StringArray(long handle)
                      throws BiosealException

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

  - ### Method Detail

    - #### close

          public void close()

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

    - #### get

          public java.lang.String get(int index)
                               throws BiosealException

      Gets an item of the StringArray object.
      Parameters:
        `index` - Index of the item to get.
      Returns:
        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 StringArray object.
      Returns:
        Number of elements in the object.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### contains

          public boolean contains(java.lang.String item)
                           throws BiosealException

      Returns a value indicating whether a specified string occurs in this string array.
      Parameters:
        `item` - The string to seek.
      Returns:
        true if the item parameter occurs within this string array; otherwise, false.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### iterator

          public java.util.Iterator<java.lang.String> iterator()

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

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