no.bekk.bekkopen.banking.KontonummerValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nocommons Show documentation

The NoCommons library is a collection of helper classes for manipulation and validation of data specific to Norway and Norwegian citizens.

There is a newer version: 0.16.0

Show newest version

package no.bekk.bekkopen.banking;

import no.bekk.bekkopen.common.StringNumberValidator;

/**
 * Provides methods that validates if a Kontonummer is valid with respect to
 * syntax (length and digits only) and that the checksum digit is correct.
 */
public class KontonummerValidator extends StringNumberValidator {

	private static final int LENGTH = 11;
	protected static final int ACCOUNTTYPE_NUM_DIGITS = 2;
	protected static final int REGISTERNUMMER_NUM_DIGITS = 4;

	private KontonummerValidator() {
		super();
	}

	/**
	 * Return true if the provided String is a valid Kontonummmer.
	 * 
	 * @param kontonummer
	 *            A String containing a Kontonummer
	 * @return true or false
	 */
	public static boolean isValid(String kontonummer) {
		try {
			KontonummerValidator.getKontonummer(kontonummer);
			return true;
		} catch (IllegalArgumentException e) {
			return false;
		}
	}

	/**
	 * Returns an object that represents a Kontonummer.
	 * 
	 * @param kontonummer
	 *            A String containing a Kontonummer
	 * @return A Kontonummer instance
	 * @throws IllegalArgumentException
	 *             thrown if String contains an invalid Kontonummer
	 */
	public static Kontonummer getKontonummer(String kontonummer) throws IllegalArgumentException {
		validateSyntax(kontonummer);
		validateChecksum(kontonummer);
		return new Kontonummer(kontonummer);
	}

	/**
	 * Returns an object that represents a Kontonummer. The checksum of the
	 * supplied kontonummer is changed to a valid checksum if the original
	 * kontonummer has an invalid checksum.
	 * 
	 * @param kontonummer
	 *            A String containing a Kontonummer
	 * @return A Kontonummer instance
	 * @throws IllegalArgumentException
	 *             thrown if String contains an invalid Kontonummer, ie. a
	 *             number which for one cannot calculate a valid checksum.
	 */
	public static Kontonummer getAndForceValidKontonummer(String kontonummer) {
		validateSyntax(kontonummer);
		try {
			validateChecksum(kontonummer);
		} catch (IllegalArgumentException iae) {
			Kontonummer k = new Kontonummer(kontonummer);
			int checksum = calculateMod11CheckSum(getMod11Weights(k), k);
			kontonummer = kontonummer.substring(0, LENGTH - 1) + checksum;
		}
		return new Kontonummer(kontonummer);
	}

	static void validateSyntax(String kontonummer) {
		validateLengthAndAllDigits(kontonummer, LENGTH);
	}

	static void validateAccountTypeSyntax(String accountType) {
		validateLengthAndAllDigits(accountType, ACCOUNTTYPE_NUM_DIGITS);
	}

	static void validateRegisternummerSyntax(String registernummer) {
		validateLengthAndAllDigits(registernummer, REGISTERNUMMER_NUM_DIGITS);
	}

	static void validateChecksum(String kontonummer) {
		Kontonummer k = new Kontonummer(kontonummer);
		int k1 = calculateMod11CheckSum(getMod11Weights(k), k);
		if (k1 != k.getChecksumDigit()) {
			throw new IllegalArgumentException(ERROR_INVALID_CHECKSUM + kontonummer);
		}
	}

}