com.gemalto.idp.mobile.msp

Interface MspField

public interface MspField

A class represents the MSP field which describes the field information such as field completeness. This class also is a helper class to work with UI components for the partial input from end users.

Since:

4.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MspField.FieldCompleteness The enum class to describe the completeness of a MSP field.

Method Summary

Modifier and Type	Method and Description
Map<Integer,Byte>	getMissingBytes() Get the missing bytes of current MspField.
SecureString	getValue() Get the value of current MspField
Map<Integer,Byte>	getVisibleBytes() Get the visible bytes of current MspField.
MspField.FieldCompleteness	isComplete() Check the completeness of current MspField.
int	updateMissingBytes(Map<Integer,Byte> missingBytes) Update the missing byte map with value input by user.

Method Detail

getMissingBytes

Map<Integer,Byte> getMissingBytes()

Get the missing bytes of current MspField. Also, see isComplete() to check if the current MspFiled is incomplete. The returned value is a map with key being the index of the missing byte and the value being '0x7F'. This API is to facilitate developers with UI handling, e.g. they may need to display something like "123x5x7x9x", the returned value for this case will be as below: {{3, 0x7f}, {5, 0x7F}, {7, 0x7F}, {9, 0x7F}}

Returns:

a map of all the missing bytes.

Since:

4.5

See Also:

getVisibleBytes(), updateMissingBytes(Map)

getValue

SecureString getValue()

Get the value of current MspField

Returns:

the value

Since:

4.5

getVisibleBytes

Map<Integer,Byte> getVisibleBytes()

Get the visible bytes of current MspField. Also, see isComplete() to check if the current MspFiled is incomplete. The returned value is a map with key being the index of the visible byte and the value. This API is to facilitate developers with UI handling, e.g. they may need to display something like "123x5x7x9x", the returned value for this case will be as below: {{0, 1}, {1, 2}, {2, 3}, {4, 5}, {6, 7}, {8, 9}}

Returns:

a map of all the visible bytes.

Since:

4.5

See Also:

getMissingBytes(), updateMissingBytes(Map)

isComplete

MspField.FieldCompleteness isComplete()

Check the completeness of current MspField.

Returns:

the completeness enum object.

Since:

4.5

See Also:

getVisibleBytes(), getMissingBytes(), updateMissingBytes(Map)

updateMissingBytes

int updateMissingBytes(Map<Integer,Byte> missingBytes)

Update the missing byte map with value input by user.

Parameters:

missingBytes - the map of all the missing bytes, the value is from user input.

Returns:

0 if the key of the missingBytes is wrong, 1 if the update is successful.

Since:

4.5

See Also:

getVisibleBytes(), getMissingBytes()