org.josef.finance

Class UKSortCodeRange

java.lang.Object

org.josef.finance.UKSortCodeRange

All Implemented Interfaces:

Comparable<UKSortCodeRange>

public class UKSortCodeRange
extends Object
implements Comparable<UKSortCodeRange>

Abstraction of a range of UK sort codes.
A sort code range determines for example what algorithm and what weights to use to verify a sort code and bank account combination.
More information and the actual table of sort code ranges are available here: http://www.vocalink.com/products/payments/customer-support-services/modulus-checking.aspx

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
int	compareTo(UKSortCodeRange ukSortCodeRange) Compares this UKSortCodeRange against the supplied ukSortCodeRange.
boolean	equals(Object object) Determines if this UKSortCodeRange is equal to the supplied object.
String	getAlgorithm() Gets the algorithm to verify a sort code in this sort code range.
int	getAlgorithmException() Gets the algorithm exception. An algorithm exception is used to compute and verify the checksum in a different way.
UKSortCodeRange	getNestedSortCodeRange() Gets the sort code range that is nested within this sort code range.
static UKSortCodeRange	getSortCodeRange(String sortCode) Gets the UKSortCodeRange corresponding to the supplied sortCode.
int[]	getWeights() Gets all the weights of this sort code range.
int	hashCode() Computes the hash code of this UKSortCodeRange.
static void	main(String[] args) Displays all sort code ranges.
String	toString() Creates a String representation of this UKSortCodeRange.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getSortCodeRange

public static UKSortCodeRange getSortCodeRange(String sortCode)

Gets the UKSortCodeRange corresponding to the supplied sortCode.

Parameters:

sortCode - The sort code to get the sort code range of.

Returns:

The UKSortCodeRange corresponding to the supplied sortCode or null when no SortCodeRange corresponds to the supplied sortCode.

getAlgorithm

public String getAlgorithm()

Gets the algorithm to verify a sort code in this sort code range.

Returns:

The algorithm to verify a sort code in this sort code range.

getAlgorithmException

public int getAlgorithmException()

Gets the algorithm exception.
An algorithm exception is used to compute and verify the checksum in a different way.

Returns:

The algorithm exception.
In the absence of an algorithm exception, 0 is returned.

getWeights

public int[] getWeights()

Gets all the weights of this sort code range.

Returns:

The weights of this sort code range.

getNestedSortCodeRange

public UKSortCodeRange getNestedSortCodeRange()

Gets the sort code range that is nested within this sort code range.

Returns:

The sort code range that is nested within this sort code range or null in the absence of a nested sorted code range.

compareTo

public int compareTo(UKSortCodeRange ukSortCodeRange)

Compares this UKSortCodeRange against the supplied ukSortCodeRange.

Specified by:

compareTo in interface Comparable<UKSortCodeRange>

Parameters:

ukSortCodeRange - The UK sort code range to check.

Returns:

-1 when this range is less than the supplied range, 0 when both ranges are equal and 1 when this range is larger than the supplied range.

equals

public boolean equals(Object object)

Determines if this UKSortCodeRange is equal to the supplied object.
The supplied object is equal when: The supplied object is of type UKSortCodeRange and both objects have the same fromRange. So if you construct two UKSOrtRange objects with the same fromRange and different fromRanges for example, this method would still consider them to be equal. This is by design as a UKSortCodeRange should have unique fromRanges.

Overrides:

equals in class Object

Parameters:

object - The UKSortCodeRange to check for equality.

Returns:

True when this UKSortCodeRange and the supplied object are equal, otherwise false is returned.

hashCode

public int hashCode()

Computes the hash code of this UKSortCodeRange.

Overrides:

hashCode in class Object

Returns:

Hash code of this UKSortCodeRange.

toString

public String toString()

Creates a String representation of this UKSortCodeRange.

Overrides:

toString in class Object

Returns:

A String representation of this UKSortCodeRange.

main

public static void main(String[] args)

Displays all sort code ranges.

Parameters:

args - Not used.