Grabba Driver for Android
Unified driver for Grabba devices on the Android operating system
FingerprintUserRecord Class Reference

Description

User record structure for use with fingerprint reader databases.

This structure contains a user ID (used as a database key) and an optional collection of associated data. A record of this type is stored for each enrolment into a fingerprint database.

Thread safety:

  • Concurrent accesses to distinct objects: safe
  • Concurrent accesses to same object: unsafe, unless all accesses are read-only (i.e. query functions)

Public Member Functions

 FingerprintUserRecord ()
 Default construction - empty ID string, no user data.
 
 FingerprintUserRecord (@NonNull String ID, @NonNull byte[] data)
 Construction, with given ID and data. More...
 
void setUserData (@NonNull byte[] newData)
 Set the user data for this record. More...
 
void setUserID (@NonNull String newID)
 Set the user ID for this record. More...
 
byte [] userData ()
 Query the user data for this record. More...
 
String userID ()
 Query the user ID for this record; this should uniquely identify a user. More...
 

Constructor & Destructor Documentation

◆ FingerprintUserRecord()

FingerprintUserRecord ( @NonNull String  ID,
@NonNull byte []  data 
)

Construction, with given ID and data.

Parameters
IDInitial value of UserID field; must uniquely identify the user
dataInitial value of UserData field

Member Function Documentation

◆ setUserData()

void setUserData ( @NonNull byte []  newData)

Set the user data for this record.

Parameters
newDataNew user data for this record, or an empty byte array if there isn't any

◆ setUserID()

void setUserID ( @NonNull String  newID)

Set the user ID for this record.

Parameters
newIDNew user ID string for this record; must uniquely identify the user in question

◆ userData()

byte [] userData ( )

Query the user data for this record.

Returns
Copy of the user data, or an empty byte array if there isn't any

◆ userID()

String userID ( )

Query the user ID for this record; this should uniquely identify a user.

Returns
Copy of the user ID string