Package jp.gopay.sdk.types

Enum CardBrand

java.lang.Object

java.lang.Enum<CardBrand>

jp.gopay.sdk.types.CardBrand

All Implemented Interfaces:

Serializable, Comparable<CardBrand>

public enum CardBrand
extends Enum<CardBrand>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMERICAN_EXPRESS
DINERS_CLUB
DISCOVER
EMPTY
JCB
MAESTRO
MASTERCARD
UNIONPAY
UNKNOWN
VISA

Method Summary

Modifier and Type	Method	Description
static CardBrand	forBrandName(String brandName)
static CardBrand	forCardNumber(String cardNumber)	Returns the card type matching this account, or UNKNOWN for no match.
String	getBrandName()
int	getMaxCardLength()
int	getMinCardLength()
Pattern	getPattern()
int	getSecurityCodeLength()
int[]	getSpaceIndices()
static boolean	isLuhnValid(String cardNumber)	Performs the Luhn check on the given card number.
boolean	validate(String cardNumber)
static CardBrand	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CardBrand[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VISA

@SerializedName("visa")
public static final CardBrand VISA

MASTERCARD

@SerializedName("mastercard")
public static final CardBrand MASTERCARD

DISCOVER

@SerializedName("discover")
public static final CardBrand DISCOVER

AMERICAN_EXPRESS

@SerializedName("american_express")
public static final CardBrand AMERICAN_EXPRESS

DINERS_CLUB

@SerializedName("diners_club")
public static final CardBrand DINERS_CLUB

JCB

@SerializedName("jcb")
public static final CardBrand JCB

MAESTRO

@SerializedName("maestro")
public static final CardBrand MAESTRO

UNIONPAY

@SerializedName("unionpay")
public static final CardBrand UNIONPAY

UNKNOWN

@SerializedName("unknown")
public static final CardBrand UNKNOWN

EMPTY

@SerializedName("empty")
public static final CardBrand EMPTY

Method Detail

values

public static CardBrand[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CardBrand c : CardBrand.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CardBrand valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forCardNumber

public static CardBrand forCardNumber(String cardNumber)

Returns the card type matching this account, or UNKNOWN for no match.

A partial account type may be given, with the caveat that it may not have enough digits to match.

forBrandName

public static CardBrand forBrandName(String brandName)

getPattern

public Pattern getPattern()

Returns:

The regex matching this card type.

getSecurityCodeLength

public int getSecurityCodeLength()

Returns:

The length of the current card's security code.

getMinCardLength

public int getMinCardLength()

Returns:

minimum length of a card for this CardType

getMaxCardLength

public int getMaxCardLength()

Returns:

max length of a card for this CardType

getBrandName

public String getBrandName()

getSpaceIndices

public int[] getSpaceIndices()

Returns:

the locations where spaces should be inserted when formatting the card in a user friendly way. Only for display purposes.

isLuhnValid

public static boolean isLuhnValid(String cardNumber)

Performs the Luhn check on the given card number.

Parameters:

cardNumber - a String consisting of numeric digits (only).

Returns:

true if the sequence passes the checksum

Throws:

IllegalArgumentException - if cardNumber contained a non-digit (where Character.isDefined(char) is false).

See Also:

Luhn Algorithm (Wikipedia)

validate

public boolean validate(String cardNumber)

Parameters:

cardNumber - The card number to validate.

Returns:

true if this card number is locally valid.