eu.id3.document

Class DocumentInfo

java.lang.Object

eu.id3.document.DocumentInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable

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

Represents document information.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DocumentInfo	clone() Creates a copy of the DocumentInfo object.
void	close() Releases all resources used by this DocumentInfo.
protected void	finalize() Finalizer for this class.
DocumentCategory	getCategory() Gets the the document category.
java.lang.String	getCountry() Gets the the ISO 3166-1 alpha-3 code identifying the country issuing the document.
java.lang.String	getDate() Gets the the document's date of first issue, in the form `YYYY-MM-DD`.
java.lang.String	getDescription() Gets the the document description.
DocumentFormat	getFormat() Gets the the document format.
long	getHandle() Gets the native handle.
java.lang.String	getIdentifier() Gets the the document identifier.
MrzType	getMrzType() Gets the the type of machine-readable zone (MRZ), if applicable.
java.lang.String	getName() Gets the the document type name.
int	getPageNumber() Gets the the page number of the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentInfo

public DocumentInfo()
             throws DocumentException

Creates a new instance of the DocumentInfo class.

Throws:

DocumentException - An error has occurred during Document Library execution.

DocumentInfo

public DocumentInfo(long handle)
             throws DocumentException

Creates a new instance of the DocumentInfo class.

Parameters:

handle - Handle to the DocumentInfo.

Throws:

DocumentException - An error has occurred during Document Library execution.

Method Detail

close

public void close()

Releases all resources used by this DocumentInfo.

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 DocumentInfo clone()
                   throws DocumentException

Creates a copy of the DocumentInfo object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created DocumentInfo object.

Throws:

DocumentException - An error has occurred during Document Library execution.

getCategory

public DocumentCategory getCategory()
                             throws DocumentException

Gets the the document category.

Returns:

The document category.

Throws:

DocumentException - An error has occurred during Document Library execution.

getCountry

public java.lang.String getCountry()
                            throws DocumentException

Gets the the ISO 3166-1 alpha-3 code identifying the country issuing the document.

Returns:

The ISO 3166-1 alpha-3 code identifying the country issuing the document.

Throws:

DocumentException - An error has occurred during Document Library execution.

getDate

public java.lang.String getDate()
                         throws DocumentException

Gets the the document's date of first issue, in the form `YYYY-MM-DD`.

Returns:

The document's date of first issue, in the form `YYYY-MM-DD`.

Throws:

DocumentException - An error has occurred during Document Library execution.

getDescription

public java.lang.String getDescription()
                                throws DocumentException

Gets the the document description.

Returns:

The document description.

Throws:

DocumentException - An error has occurred during Document Library execution.

getFormat

public DocumentFormat getFormat()
                         throws DocumentException

Gets the the document format.

Returns:

The document format.

Throws:

DocumentException - An error has occurred during Document Library execution.

getIdentifier

public java.lang.String getIdentifier()
                               throws DocumentException

Gets the the document identifier.

Returns:

The document identifier.

Throws:

DocumentException - An error has occurred during Document Library execution.

getMrzType

public MrzType getMrzType()
                   throws DocumentException

Gets the the type of machine-readable zone (MRZ), if applicable.

Returns:

The type of machine-readable zone (MRZ), if applicable.

Throws:

DocumentException - An error has occurred during Document Library execution.

getName

public java.lang.String getName()
                         throws DocumentException

Gets the the document type name.

Returns:

The document type name.

Throws:

DocumentException - An error has occurred during Document Library execution.

getPageNumber

public int getPageNumber()
                  throws DocumentException

Gets the the page number of the document.

Returns:

The page number of the document.

Throws:

DocumentException - An error has occurred during Document Library execution.