Package com.microblink.blinkid.entities.recognizers.blinkbarcode.usdl

Class UsdlRecognizer.Result

java.lang.Object
com.microblink.blinkid.entities.Entity.Result
com.microblink.blinkid.entities.recognizers.Recognizer.Result
com.microblink.blinkid.entities.recognizers.blinkbarcode.usdl.UsdlRecognizer.Result
All Implemented Interfaces:
android.os.Parcelable
Enclosing class:
UsdlRecognizer
public static final class UsdlRecognizer.Result extends Recognizer.Result

  • Field Details

  • Constructor Details

    • Result

      protected Result(long nativeResult)

  • Method Details

    • getLastName

      @NonNull public String getLastName()
      The last name of the United States driver license owner.

    • getDateOfExpiry

      @NonNull public Date getDateOfExpiry()
      The date of expiry of the United States driver license.

    • getAddress

      @NonNull public String getAddress()
      The full address of the United States driver license owner.

    • getCity

      @NonNull public String getCity()
      The city address portion of the United States driver license owner.

    • getDocumentNumber

      @NonNull public String getDocumentNumber()
      The document number of the United States driver license.

    • getPostalCode

      @NonNull public String getPostalCode()
      The postal code address portion of the United States driver license owner.

    • getJurisdiction

      @NonNull public String getJurisdiction()
      The jurisdiction code address portion of the United States driver license owner.

    • getSex

      @NonNull public String getSex()
      The sex of the United States driver license owner.

    • getFullName

      @NonNull public String getFullName()
      The full name of the United States driver license owner.

    • getNameSuffix

      @NonNull public String getNameSuffix()
      The name suffix of the United States driver license owner.

    • getRestrictions

      @NonNull public String getRestrictions()
      The restrictions to driving privileges for the United States driver license owner.

    • getDateOfBirth

      @NonNull public Date getDateOfBirth()
      The date of birth of the United States driver license owner.

    • getRawData

      @NonNull public byte[] getRawData()
      The raw bytes contained inside 2D barcode.

    • getDateOfIssue

      @NonNull public Date getDateOfIssue()
      The date of issue of the United States driver license.

    • isUncertain

      public boolean isUncertain()
      True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. (has parts of it missing).

    • getFirstName

      @NonNull public String getFirstName()
      The first name of the United States driver license owner.

    • getStreet

      @NonNull public String getStreet()
      The street address portion of the United States driver license owner.

    • getEndorsements

      @NonNull public String getEndorsements()
      The additional privileges granted to the United States driver license owner.

    • getVehicleClass

      @NonNull public String getVehicleClass()
      The type of vehicle the driver license owner has privilege to drive.

    • getMiddleName

      @NonNull public String getMiddleName()
      The middle name of the United States driver license owner.

    • getRawStringData

      @NonNull public String getRawStringData()
      Raw string inside 2D barcode.

    • getAge

      public int getAge()
      The current age of the document owner in years. It is calculated difference between now and date of birth. Now is current time on the device.
      Returns:
      current age of the document owner in years or -1 if date of birth is unknown.

    • getAgeLimitStatus

      public AgeLimitStatus getAgeLimitStatus(int ageLimit)
      Calculates whether the document owner is older than the given ageLimit in years or not. Status is calculated by using the date of birth and the current time on the device.
      Parameters:
      ageLimit - age limit in years
      Returns:
      age limit status for the document owner:

    • getOptionalElements

      @NonNull @Deprecated public String[] getOptionalElements()
      Deprecated.
      Array of elements that are not part of AAMVA standard and are specific to each US state. If no specific elements existed inside 2D barcode, this is an empty array. Otherwise, this array contains list of state-specific elements in the same order as given inside barcode. NOTE: Size of this array is both state-specific and barcode-specific. Each US state has ability to arbitrarily define size and contents of these elements. You can obtain the US state with getField(UsdlKeys) and using UsdlKeys.IssuingJurisdictionName as a parameter.

    • getField

      @NonNull public String getField(@NonNull UsdlKeys key)
      Returns a field inside US Driver's licence. Available Keys are listed in UsdlKeys enum.
      Parameters:
      key - Key representing the required information.
      Returns:
      required information (if it exists), or empty string if it does not

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      string version of this result

    • serializeToByteArray

      @Nullable protected byte[] serializeToByteArray()
      Specified by:
      serializeToByteArray in class Entity.Result

    • deserializeFromByteArray

      protected void deserializeFromByteArray(@NonNull byte[] arr)
      Specified by:
      deserializeFromByteArray in class Entity.Result

    • clone

      public UsdlRecognizer.Result clone()
      Description copied from class: Entity.Result
      Create a copy of the result. This is required in order to retain the result even after owning entity has mutated it.
      Specified by:
      clone in class Recognizer.Result
      Returns:
      a copy of the result

    • terminateNative

      protected void terminateNative(long nativeContext)
      Specified by:
      terminateNative in class Entity.Result