com.scvngr.levelup.core.model.qr

Class PaymentPreferencesV3

java.lang.Object

com.scvngr.levelup.core.model.qr.PaymentPreferences

com.scvngr.levelup.core.model.qr.PaymentPreferencesV3

@Immutable
 @LevelUpApi(contract=INTERNAL)
public final class PaymentPreferencesV3
extends PaymentPreferences

This class may be used to encode and parse version 3 payment preferences. In version 3, payment preferences are represented as an 8 character code which consists of four sections, each of which is encoded in base 36. A typical payment preferences code:

030002LU

Each section has a specific length prescribed to it. When necessary, leading zeros may be added to a section to ensure that it conforms to this length. The following is a description of each section, using 030002LU as an example:

• [03] The version of the payment preference code. (length 2)
• [000] The value of the tip, either as a percentage or US cents. Within this section, each tip value type is assigned to an exclusive range of base 36 values. (length 3)
• [2] The glow color index preference. (length 1)
• [LU] The sentinel value which is always encoded as "LU". (length 2)

Percentage tip values are assigned to base 36 values ranging from 000 through 0ZZ. This range can represent percentage values from 0% through 1295%.

US cent tip values are assigned to base 36 values ranging from 100 through ZZZ. This range can represent US cent values from $0.00 through $453.59.

Field Summary

Fields inherited from class com.scvngr.levelup.core.model.qr.PaymentPreferences

COLOR_UNKNOWN, mPaymentPreferences

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PaymentPreferencesV3(String paymentPreferences)

Method Summary

Modifier and Type	Method and Description
protected int	getColor() Subclasses must implement this to return the color index parsed or PaymentPreferences.COLOR_UNKNOWN.

Methods inherited from class com.scvngr.levelup.core.model.qr.PaymentPreferences

getColorPreference

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentPreferencesV3

protected PaymentPreferencesV3(String paymentPreferences)

Parameters:

paymentPreferences - the preference string.

Method Detail

getColor

protected int getColor()

Description copied from class: PaymentPreferences

Subclasses must implement this to return the color index parsed or PaymentPreferences.COLOR_UNKNOWN.

Specified by:

getColor in class PaymentPreferences

Returns:

the color index (in the array) or PaymentPreferences.COLOR_UNKNOWN if none could be parsed.