eu.id3.bioseal

Class Log

java.lang.Object

eu.id3.bioseal.Log

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable, java.lang.Iterable<LogItem>

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

Represents the log.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Log() Creates a new instance of the Log class.
Log(long handle) Creates a new instance of the Log class.

Method Summary

Modifier and Type	Method and Description
void	close() Releases all resources used by this Log.
java.lang.String	exportToHtml(boolean debug) Exports a representation of the log, in HTML format.
java.lang.String	exportToJson(java.lang.String indentation, boolean debug) Exports a representation of the log, in JSON format.
protected void	finalize() Finalizer for this class.
LogItem	get(int index) Gets an item of the Log object.
int	getCount() Gets the number of elements in the Log object.
long	getHandle() Gets the native handle.
java.util.Iterator<LogItem>	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

Log

public Log()
    throws BiosealException

Creates a new instance of the Log class.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

Log

public Log(long handle)
    throws BiosealException

Creates a new instance of the Log class.

Parameters:

handle - Handle to the Log.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

Method Detail

close

public void close()

Releases all resources used by this Log.

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 LogItem get(int index)
            throws BiosealException

Gets an item of the Log object.

Parameters:

index - Index of the LogItem item to get.

Returns:

LogItem 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 Log object.

Returns:

Number of elements in the LogItem object.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

exportToJson

public java.lang.String exportToJson(java.lang.String indentation,
                                     boolean debug)
                              throws BiosealException

Exports a representation of the log, in JSON format.

Parameters:

indentation - The indentation of the json string.

debug - Indicates whether debug information is added to the log.

Returns:

The result.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

exportToHtml

public java.lang.String exportToHtml(boolean debug)
                              throws BiosealException

Exports a representation of the log, in HTML format.

Parameters:

debug - Indicates whether debug information is added to the log.

Returns:

The result.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

iterator

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

Specified by:

iterator in interface java.lang.Iterable<LogItem>