Bankleitzahl (jDTAUS Banking ⁑ API 1.16)

java.lang.Object
- java.lang.Number
- - org.jdtaus.banking.Bankleitzahl

All Implemented Interfaces:

Serializable, Comparable
```
public final class Bankleitzahl
extends Number
implements Comparable
```
Unique identifier to a particular office (branch) of a german bank.
A Bankleitzahl (BLZ) is a positive integer with a maximum of eight digits. For further information see the Merkblatt Bankleitzahlendatei. An updated version of the document may be found at Deutsche Bundesbank.

Version:

$JDTAUS: Bankleitzahl.java 8725 2012-10-04 21:26:50Z schulte $

Author:

Christian Schulte

See Also:
BankleitzahlenVerzeichnis, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ELECTRONIC_FORMAT` Constant for the electronic format of a Bankleitzahl.
`static int`	`LETTER_FORMAT` Constant for the letter format of a Bankleitzahl.
`static int`	`MAX_CHARACTERS` Maximum number of characters of a Bankleitzahl.
`static int`	`MAX_DIGITS` Maximum number of digits of a Bankleitzahl.

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`checkBankleitzahl(Number bankCode)` Checks a given number to conform to a Bankleitzahl.
`int`	`compareTo(Object o)` Compares this object with the specified object for order.
`double`	`doubleValue()` Returns this Bankleitzahl as a double value.
`boolean`	`equals(Object o)` Indicates whether some other object is equal to this one.
`float`	`floatValue()` Returns this Bankleitzahl as a float value.
`String`	`format(int style)` Formats a Bankleitzahl to produce a string.
`StringBuffer`	`format(int style, StringBuffer toAppendTo)` Formats a Bankleitzahl and appends the resulting text to the given string buffer.
`int`	`getClearingAreaCode()` Gets the clearing area code of this Bankleitzahl.
`int`	`getInstituteCode()` Gets the institute code of this Bankleitzahl.
`int`	`getLocalityCode()` Gets the locality code of this Bankleitzahl.
`int`	`getNetworkCode()` Gets the network code of this Bankleitzahl.
`int`	`hashCode()` Returns a hash code value for this object.
`int`	`intValue()` Returns this Bankleitzahl as an int value.
`boolean`	`isClearingAreaCodeSupported()` Gets a flag indicating that this Bankleitzahl provides a clearing area code.
`boolean`	`isLocalityCodeSupported()` Gets a flag indicating that this Bankleitzahl provides a locality code.
`boolean`	`isNetworkCodeSupported()` Gets a flag indicating that this Bankleitzahl provides a network code.
`long`	`longValue()` Returns this Bankleitzahl as a long value.
`static Bankleitzahl`	`parse(String bankCode)` Parses text from the beginning of the given string to produce a `Bankleitzahl`.
`static Bankleitzahl`	`parse(String bankCode, ParsePosition pos)` Parses text from a string to produce a `Bankleitzahl`.
`String`	`toString()` Returns a string representation of the object.
`static String`	`toString(Bankleitzahl bankleitzahl)` Formats a Bankleitzahl to produce a string.
`static Bankleitzahl`	`valueOf(Number bankCode)` Gets a `Bankleitzahl` for a given number.
`static Bankleitzahl`	`valueOf(String bankCode)` Parses text from the beginning of the given string to produce a `Bankleitzahl`.

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- ELECTRONIC_FORMAT
```
public static final int ELECTRONIC_FORMAT
```
  Constant for the electronic format of a Bankleitzahl.
  The electronic format of a Bankleitzahl is an eigth digit number with leading zeros omitted (e.g. 5678).
  
  See Also:
  Constant Field Values
- LETTER_FORMAT
```
public static final int LETTER_FORMAT
```
  Constant for the letter format of a Bankleitzahl.
  The letter format of a Bankleitzahl is an eigth digit number with leading zeros omitted separated by spaces between the first three digits and the second three digits, and between the second three digits and the last two digits (e.g. 123 456 78).
  
  See Also:
  Constant Field Values
- MAX_CHARACTERS
```
public static final int MAX_CHARACTERS
```
  Maximum number of characters of a Bankleitzahl.
  
  See Also:
  Constant Field Values
- MAX_DIGITS
```
public static final int MAX_DIGITS
```
  Maximum number of digits of a Bankleitzahl.
  
  See Also:
  Constant Field Values

Method Detail

checkBankleitzahl
```
public static boolean checkBankleitzahl(Number bankCode)
```
Checks a given number to conform to a Bankleitzahl.

Parameters:
bankCode - The number to check.

Returns:
true if bankCode is a valid Bankleitzahl; false if not.

compareTo
```
public int compareTo(Object o)
```
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface Comparable

Parameters:
o - The Object to be compared.

Returns:
A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

NullPointerException - if o is null.

ClassCastException - if the specified object's type prevents it from being compared to this Object.

doubleValue
```
public double doubleValue()
```
Returns this Bankleitzahl as a double value.

Specified by:

doubleValue in class Number

Returns:
This Bankleitzahl as a double value.

equals
```
public boolean equals(Object o)
```
Indicates whether some other object is equal to this one.

Overrides:

equals in class Object

Parameters:
o - The reference object with which to compare.

Returns:
true if this object is the same as o; false otherwise.

floatValue
```
public float floatValue()
```
Returns this Bankleitzahl as a float value.

Specified by:

floatValue in class Number

Returns:
This Bankleitzahl as a float value.

format
```
public String format(int style)
```
Formats a Bankleitzahl to produce a string. Same as
format(style, new StringBuffer()).toString()

Parameters:
style - The style to use (ELECTRONIC_FORMAT or LETTER_FORMAT).

Returns:
The formatted string.

Throws:

IllegalArgumentException - if style is neither ELECTRONIC_FORMAT nor LETTER_FORMAT.
See Also:
ELECTRONIC_FORMAT, LETTER_FORMAT

format
```
public StringBuffer format(int style,
                  StringBuffer toAppendTo)
```
Formats a Bankleitzahl and appends the resulting text to the given string buffer.

Parameters:
style - The style to use (ELECTRONIC_FORMAT or LETTER_FORMAT).
toAppendTo - The buffer to which the formatted text is to be appended.

Returns:
The value passed in as toAppendTo.

Throws:

NullPointerException - if toAppendTo is null.

IllegalArgumentException - if style is neither ELECTRONIC_FORMAT nor LETTER_FORMAT.
See Also:
ELECTRONIC_FORMAT, LETTER_FORMAT

getClearingAreaCode
```
public int getClearingAreaCode()
```
Gets the clearing area code of this Bankleitzahl.
1. Berlin, Brandenburg, Mecklenburg-Vorpommern
2. Bremen, Hamburg, Niedersachsen, Schleswig-Holstein
3. Rheinland (Regierungsbezirke Düsseldorf, Köln)
4. Westfalen
5. Hessen, Rheinland-Pfalz, Saarland
6. Baden-Württemberg
7. Bayern
8. Sachsen, Sachsen-Anhalt, Thüringen
Returns:
Code identifying the clearing area of this Bankleitzahl.

Throws:

UnsupportedOperationException - if this Bankleitzahl does not provide clearing area information.
See Also:
isClearingAreaCodeSupported()

getInstituteCode
```
public int getInstituteCode()
```
Gets the institute code of this Bankleitzahl.

Returns:
Institute code of this Bankleitzahl.

getLocalityCode
```
public int getLocalityCode()
```
Gets the locality code of this Bankleitzahl.

Returns:
Locality code of this Bankleitzahl.

Throws:

UnsupportedOperationException - if this Bankleitzahl does not provide a locality code.
See Also:
isLocalityCodeSupported()

getNetworkCode

public int getNetworkCode()

Gets the network code of this Bankleitzahl.

0	Deutsche Bundesbank
1 - 3	Kreditinstitute, soweit nicht in einer der anderen Gruppen erfasst
4	Commerzbank
5	Girozentralen und Sparkassen
6 + 9	Genossenschaftliche Zentralbanken, Kreditgenossenschaften sowie ehemalige Genossenschaften
7	Deutsche Bank
8	Dresdner Bank

Returns:: Network code of this Bankleitzahl.
Throws:: UnsupportedOperationException - if this Bankleitzahl does not provide a network code.
See Also:: isNetworkCodeSupported()

hashCode
```
public int hashCode()
```
Returns a hash code value for this object.

Overrides:

hashCode in class Object

Returns:
A hash code value for this object.

intValue
```
public int intValue()
```
Returns this Bankleitzahl as an int value.

Specified by:

intValue in class Number

Returns:
This Bankleitzahl as an int value.

isClearingAreaCodeSupported
```
public boolean isClearingAreaCodeSupported()
```
Gets a flag indicating that this Bankleitzahl provides a clearing area code.

Returns:
true if property clearingAreaCode is supported by this instance; false if property clearingAreaCode is not supported by this instance.
See Also:
getClearingAreaCode()

isLocalityCodeSupported
```
public boolean isLocalityCodeSupported()
```
Gets a flag indicating that this Bankleitzahl provides a locality code.

Returns:
true if property localityCode is supported by this instance; false if property localityCode is not supported by this instance.
See Also:
getLocalityCode()

isNetworkCodeSupported
```
public boolean isNetworkCodeSupported()
```
Gets a flag indicating that this Bankleitzahl provides a network code.

Returns:
true if property networkCode is supported by this instance; false if property networkCode is not supported by this instance.
See Also:
getNetworkCode()

longValue
```
public long longValue()
```
Returns this Bankleitzahl as a long value.

Specified by:

longValue in class Number

Returns:
This Bankleitzahl as a long value.

parse
```
public static Bankleitzahl parse(String bankCode)
                          throws ParseException
```
Parses text from the beginning of the given string to produce a Bankleitzahl.
Unlike the parse(String, ParsePosition) method this method throws a ParseException if bankCode cannot be parsed or is of invalid length.

Parameters:
bankCode - A Bankleitzahl in either electronic or letter format.

Returns:
The parsed value.

Throws:

NullPointerException - if bankCode is null.

ParseException - if the parse fails or bankCode is of invalid length.

parse
```
public static Bankleitzahl parse(String bankCode,
                 ParsePosition pos)
```
Parses text from a string to produce a Bankleitzahl.
The method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index of pos is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed value is returned. The updated pos can be used to indicate the starting point for the next call to this method.

Parameters:
bankCode - A Bankleitzahl in either electronic or letter format.
pos - A ParsePosition object with index and error index information as described above.

Returns:
The parsed value, or null if the parse fails.

Throws:

NullPointerException - if either bankCode or pos is null.

toString
```
public String toString()
```
Returns a string representation of the object.

Overrides:

toString in class Object

Returns:
A string representation of the object.

toString
```
public static String toString(Bankleitzahl bankleitzahl)
```
Formats a Bankleitzahl to produce a string. Same as
bankleitzahl.format(ELECTRONIC_FORMAT)

Parameters:
bankleitzahl - The Bankleitzahl instance to format.

Returns:
The formatted string.

Throws:

NullPointerException - if bankleitzahl is null.

valueOf
```
public static Bankleitzahl valueOf(Number bankCode)
```
Gets a Bankleitzahl for a given number.

Parameters:
bankCode - A number to get a Bankleitzahl for.

Returns:
An instance for bankCode.

Throws:

NullPointerException - if bankCode is null.

IllegalArgumentException - if bankCode is negative, zero, greater than 99999999 or its first digit is either zero or nine.
See Also:
checkBankleitzahl(Number)

valueOf
```
public static Bankleitzahl valueOf(String bankCode)
```
Parses text from the beginning of the given string to produce a Bankleitzahl.
Unlike the parse(String) method this method throws an IllegalArgumentException if bankCode cannot be parsed or is of invalid length.

Parameters:
bankCode - A Bankleitzahl in either electronic or letter format.

Returns:
The parsed value.

Throws:

NullPointerException - if bankCode is null.

IllegalArgumentException - if the parse fails or bankCode is of invalid length.

Class Bankleitzahl

Field Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ELECTRONIC_FORMAT

LETTER_FORMAT

MAX_CHARACTERS

MAX_DIGITS

Method Detail

checkBankleitzahl

compareTo

doubleValue

equals

floatValue

format

format

getClearingAreaCode

getInstituteCode

getLocalityCode

getNetworkCode

hashCode

intValue

isClearingAreaCodeSupported

isLocalityCodeSupported

isNetworkCodeSupported

longValue

parse

parse

toString

toString

valueOf

valueOf