com.scvngr.levelup.core.model.qr

Class LevelUpCode

java.lang.Object

com.scvngr.levelup.core.model.qr.LevelUpCode

Direct Known Subclasses:

PaymentTokenV2

@Immutable
 @LevelUpApi(contract=PUBLIC)
public abstract class LevelUpCode
extends Object

Class to represent a QR code. Note: this is not a representation of the web service model.

The primary goal of this class is to enable the parsing of colors from the QR codes scanned by the merchant. This does not validate codes, it attempts to determine code version for the sole purpose of parsing colors. The server will always be the final validator of codes.

Callers should not instantiate this class, they should just call parseColor(Resources, String) and it will return the color parsed or the default color.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mData The QR code data.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LevelUpCode(String qrData)

Method Summary

Modifier and Type	Method and Description
protected static int	decodeColor(int position, Resources resources)
static String	encodeLevelUpCode(String data, int color, int tipValue) Deprecated. use encodeLevelUpCode(String, int, Tip) instead.
static String	encodeLevelUpCode(String data, int color, Tip<?> tip) Encodes the payment preferences to the end of the QR code string passed.
protected abstract int	getColor(Resources resources) Get the color from this LevelUp code.
static int	parseColor(Resources resources, String qrData) Parse the color parameter from this QR code.

Methods inherited from class java.lang.Object

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

Field Detail

mData

protected final String mData

The QR code data.

Constructor Detail

LevelUpCode

protected LevelUpCode(String qrData)

Parameters:

qrData - the data read from the QR code

Method Detail

parseColor

public static int parseColor(Resources resources,
                             String qrData)

Parse the color parameter from this QR code. Try all supported versions of the QR code, falling back to the default dock scan color if no color can be parsed.

Parameters:

resources - the resources to use to get color resources.

qrData - the QR code string scanned.

Returns:

the color the dock should display.

encodeLevelUpCode

public static String encodeLevelUpCode(String data,
                                       int color,
                                       Tip<?> tip)

Encodes the payment preferences to the end of the QR code string passed.

Parameters:

data - the QR code data to append the preferences to.

color - the color to encode. This value is between 0 and 9, indexing into a list of preset colors.

tip - the tip to encode.

Returns:

the String with the payment preferences encoded into it.

encodeLevelUpCode

@Deprecated
public static String encodeLevelUpCode(String data,
                                                   int color,
                                                   int tipValue)

Deprecated. use encodeLevelUpCode(String, int, Tip) instead.

Encodes the payment preferences to the end of the QR code string passed.

Parameters:

data - the QR code data to append the preferences to.

color - the color to encode. This value is between 0 and 9, indexing into a list of preset colors.

tipValue - the tip value to encode.

Returns:

the String with the payment preferences encoded into it.

getColor

protected abstract int getColor(Resources resources)

Get the color from this LevelUp code.

Parameters:

resources - the resources to use to resolve the color.

Returns:

the int color or PaymentPreferences.COLOR_UNKNOWN if none were found in QR code.

decodeColor

protected static int decodeColor(int position,
                                 Resources resources)

Parameters:

position - the position in the color array that was parsed from the QR code data.

resources - Application resources.

Returns:

The color decoded from colorToDecode or PaymentPreferences.COLOR_UNKNOWN if colorToDecode couldn't be decoded.