org.apache.commons.validator

Class CreditCardValidator

public class CreditCardValidator extends Object

Perform credit card validations.

By default, all supported card types are allowed. You can specify which cards should pass validation by configuring the validation options. For example,
CreditCardValidator ccv = new CreditCardValidator(CreditCardValidator.AMEX + CreditCardValidator.VISA); configures the validator to only pass American Express and Visa cards. If a card type is not directly supported by this class, you can implement the CreditCardType interface and pass an instance into the addAllowedCardType method.

For a similar implementation in Perl, reference Sean M. Burke's script. More information is also available here.

Since: Validator 1.1

Nested Class Summary
classCreditCardValidator.Amex
interfaceCreditCardValidator.CreditCardType
CreditCardType implementations define how validation is performed for one type/brand of credit card.
classCreditCardValidator.Discover
classCreditCardValidator.Mastercard
classCreditCardValidator.Visa
Field Summary
static intAMEX
Option specifying that American Express cards are allowed.
CollectioncardTypes
The CreditCardTypes that are allowed to pass validation.
static intDISCOVER
Option specifying that Discover cards are allowed.
static intMASTERCARD
Option specifying that Mastercard cards are allowed.
static intNONE
Option specifying that no cards are allowed.
static intVISA
Option specifying that Visa cards are allowed.
Constructor Summary
CreditCardValidator()
Create a new CreditCardValidator with default options.
CreditCardValidator(int options)
Create a new CreditCardValidator with the specified options.
Method Summary
voidaddAllowedCardType(CreditCardValidator.CreditCardType type)
Add an allowed CreditCardType that participates in the card validation algorithm.
booleanisValid(String card)
Checks if the field is a valid credit card number.
protected booleanisValidPrefix(String card)
Checks for a valid credit card number.
protected booleanluhnCheck(String cardNumber)
Checks for a valid credit card number.

Field Detail

AMEX

public static final int AMEX
Option specifying that American Express cards are allowed.

cardTypes

private Collection cardTypes
The CreditCardTypes that are allowed to pass validation.

DISCOVER

public static final int DISCOVER
Option specifying that Discover cards are allowed.

MASTERCARD

public static final int MASTERCARD
Option specifying that Mastercard cards are allowed.

NONE

public static final int NONE
Option specifying that no cards are allowed. This is useful if you want only custom card types to validate so you turn off the default cards with this option.
 CreditCardValidator v = new CreditCardValidator(CreditCardValidator.NONE);
 v.addAllowedCardType(customType);
 v.isValid(aCardNumber);
 

Since: Validator 1.1.2

VISA

public static final int VISA
Option specifying that Visa cards are allowed.

Constructor Detail

CreditCardValidator

public CreditCardValidator()
Create a new CreditCardValidator with default options.

CreditCardValidator

public CreditCardValidator(int options)
Create a new CreditCardValidator with the specified options.

Parameters: options Pass in CreditCardValidator.VISA + CreditCardValidator.AMEX to specify that those are the only valid card types.

Method Detail

addAllowedCardType

public void addAllowedCardType(CreditCardValidator.CreditCardType type)
Add an allowed CreditCardType that participates in the card validation algorithm.

Parameters: type The type that is now allowed to pass validation.

Since: Validator 1.1.2

isValid

public boolean isValid(String card)
Checks if the field is a valid credit card number.

Parameters: card The card number to validate.

isValidPrefix

protected boolean isValidPrefix(String card)

Deprecated: This will be removed in a future release.

Checks for a valid credit card number.

Parameters: card Credit Card Number.

luhnCheck

protected boolean luhnCheck(String cardNumber)
Checks for a valid credit card number.

Parameters: cardNumber Credit Card Number.

Copyright (c) 2001-2004 Apache Software Foundation