eu.id3.document

Class HologramAuthenticationResult

java.lang.Object

eu.id3.document.HologramAuthenticationResult

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable

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

Represents the result of hologram authentication.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HologramAuthenticationResult	clone() Creates a copy of the HologramAuthenticationResult object.
void	close() Releases all resources used by this HologramAuthenticationResult.
protected void	finalize() Finalizer for this class.
Rectangle	getBounds() Gets the exact bounds of the text in the image.
float	getCorrelationScore() Gets the correlation of the variation to the background.
long	getHandle() Gets the native handle.
java.lang.String	getHologramName() Gets the name of the hologram.
float	getVariationScore() Gets the variation of the OVI color.

Methods inherited from class java.lang.Object

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

Constructor Detail

HologramAuthenticationResult

public HologramAuthenticationResult()
                             throws DocumentException

Creates a new instance of the HologramAuthenticationResult class.

Throws:

DocumentException - An error has occurred during Document Library execution.

HologramAuthenticationResult

public HologramAuthenticationResult(long handle)
                             throws DocumentException

Creates a new instance of the HologramAuthenticationResult class.

Parameters:

handle - Handle to the HologramAuthenticationResult.

Throws:

DocumentException - An error has occurred during Document Library execution.

Method Detail

close

public void close()

Releases all resources used by this HologramAuthenticationResult.

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.

clone

public HologramAuthenticationResult clone()
                                   throws DocumentException

Creates a copy of the HologramAuthenticationResult object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created HologramAuthenticationResult object.

Throws:

DocumentException - An error has occurred during Document Library execution.

getBounds

public Rectangle getBounds()
                    throws DocumentException

Gets the exact bounds of the text in the image.

Returns:

Exact bounds of the text in the image.

Throws:

DocumentException - An error has occurred during Document Library execution.

getCorrelationScore

public float getCorrelationScore()
                          throws DocumentException

Gets the correlation of the variation to the background.

Returns:

Correlation of the variation to the background.

Throws:

DocumentException - An error has occurred during Document Library execution.

getHologramName

public java.lang.String getHologramName()
                                 throws DocumentException

Gets the name of the hologram.

Returns:

Name of the hologram.

Throws:

DocumentException - An error has occurred during Document Library execution.

getVariationScore

public float getVariationScore()
                        throws DocumentException

Gets the variation of the OVI color.

Returns:

Variation of the OVI color.

Throws:

DocumentException - An error has occurred during Document Library execution.