com.scvngr.levelup.core.model.qr

Class CodeVersionUtils

java.lang.Object

com.scvngr.levelup.core.model.qr.CodeVersionUtils

@LevelUpApi(contract=INTERNAL)
public final class CodeVersionUtils
extends Object

Helper class to provide utilities for checking the version of QR code and its sub-codes.

Method Summary

Modifier and Type	Method and Description
static boolean	isValidCode(String code, int expectedLength, int codeVersionStartIndex, int codeVersionEndIndex, int expectedVersion) Utility method to check validity of the provided code.
static String	leftPadWithZeros(String toPad, int finalSize) Left pads a string with zeros.

Methods inherited from class java.lang.Object

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

Method Detail

isValidCode

public static boolean isValidCode(String code,
                                  int expectedLength,
                                  int codeVersionStartIndex,
                                  int codeVersionEndIndex,
                                  int expectedVersion)

Utility method to check validity of the provided code. The version must be base 36 encoded.

Parameters:

code - the code string to check.

expectedLength - the length the code must be.

codeVersionStartIndex - the start index (INCLUSIVE) to get the code version from.

codeVersionEndIndex - the end index (EXCLUSIVE) to get the code version from.

expectedVersion - the version code that the code's version should be checked against.

Returns:

true if the code passes the expected length and version checks.

leftPadWithZeros

public static String leftPadWithZeros(String toPad,
                                      int finalSize)

Left pads a string with zeros.

Parameters:

toPad - the string to pad with zeros.

finalSize - the required size of the string. (cannot be negative)

Returns:

a string padded with zeros on the left.

Throws:

IllegalArgumentException - if finalSize is negative.