IBAN (jDTAUS ⁑ ISO-13616 2007.45)

java.lang.Object
- org.jdtaus.iso13616.IBAN

All Implemented Interfaces:

Serializable, CharSequence, Comparable<IBAN>, Formattable
```
@Generated(value="org.jomc.tools.SourceFileProcessor 1.5",
           comments="See http://www.jomc.org/jomc/1.5/jomc-tools-1.5")
public final class IBAN
extends Object
implements CharSequence, Comparable<IBAN>, Formattable, Serializable
```
International Bank Account Number.
The IBAN structure is defined in ISO 13616-1 and consists of a two-letter ISO 3166-1 country code, followed by two check digits and up to thirty alphanumeric characters for a BBAN (Basic Bank Account Number) which has a fixed length per country and, included within it, a bank identifier with a fixed position and a fixed length per country. The check digits are calculated based on the scheme defined in ISO/IEC 7064 (MOD97-10). The Society for Worldwide Interbank Financial Telecommunication SCRL, SWIFT, has been designated by the ISO Technical Management Board to act as the Registration Authority for ISO 13616. Nationally-agreed, ISO 13616-compliant IBAN formats are submitted to the registration authority exclusively by the National Standards Body or the National Central Bank of the country. For further information see the IBAN REGISTRY. An updated version of the document may be found at SWIFT.

Identifier:
jDTAUS ⁑ ISO-13616 ⁑ IBAN

Name:
jDTAUS ⁑ ISO-13616 ⁑ IBAN

Abstract:
No

Final:
Yes

Stateless:
No

Version:

1.0

Author:

Christian Schulte

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_CHARACTERS
Maximum number of characters of an IBAN.

Fields
Modifier and Type	Field and Description
`static int`	`MAX_CHARACTERS` Maximum number of characters of an `IBAN`.

Method Summary

Methods
Modifier and Type	Method and Description
`Appendable`	`append(IbanFormat format, Appendable appendable)` Formats an IBAN and appends the resulting text to a given `Appendable`.
`char`	`charAt(int index)` Returns the `char` value at the specified index.
`int`	`compareTo(IBAN o)` Compares this object with the specified object for order.
`boolean`	`equals(Object o)` Indicates whether some other object is equal to this one.
`void`	`formatTo(Formatter formatter, int flags, int width, int precision)` Formats the object using the provided `Formatter`.
`String`	`getBankIdentifier()` Gets the bank identifier part of the BBAN of the IBAN.
`String`	`getBranchIdentifier()` Gets the branch identifier part of the BBAN of the IBAN.
`String`	`getCountryCode()` Gets the two-letter ISO 3166-1 country code of the IBAN.
`static String[]`	`getCountryCodes()` Gets an array holding two-letter ISO 3166-1 country codes of all countries that have implemented the IBAN standard.
`int`	`hashCode()` Gets the hash code value of the object.
`static boolean`	`isIbanAlphabet(char c)` Checks a given character to belong to the IBAN alphabet.
`boolean`	`isSepaCountry()` Gets a flag indicating Single Euro Payments Area membership of the country of the IBAN.
`int`	`length()` Returns the length of this character sequence.
`static IBAN`	`parse(String text)` Parses text from the beginning of the given string to produce an `IBAN` instance.
`static IBAN`	`parse(String text, ParsePosition pos)` Parses text from a string to produce an `IBAN` instance.
`static IBAN`	`parse(String countryCode, String bban)` Parses text from a BBAN string to produce an `IBAN` instance.
`static boolean`	`peekIban(String text)` Parses text from a string to peek at a national `IBAN` format.
`CharSequence`	`subSequence(int start, int end)` Returns a new `CharSequence` that is a subsequence of this sequence.
`String`	`toString()` Gets a string representation of the object.
`String`	`toString(IbanFormat format)` Formats an IBAN to produce a string.
`static IBAN`	`valueOf(String text)` Parses text from the beginning of the given string to produce an `IBAN` instance.

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

- Field Detail
  - MAX_CHARACTERS
```
public static final int MAX_CHARACTERS
```
    Maximum number of characters of an IBAN.
    
    See Also:
    Constant Field Values
- Method Detail
  - getCountryCodes
```
public static String[] getCountryCodes()
```
    Gets an array holding two-letter ISO 3166-1 country codes of all countries that have implemented the IBAN standard.
    
    Returns:
    An array holding two-letter ISO 3166-1 country codes of all countries that have implemented the IBAN standard.
  - getCountryCode
```
public String getCountryCode()
```
    Gets the two-letter ISO 3166-1 country code of the IBAN.
    
    Returns:
    The two-letter ISO 3166-1 country code of the IBAN.
    See Also:
    getCountryCodes()
  - isSepaCountry
```
public boolean isSepaCountry()
```
    Gets a flag indicating Single Euro Payments Area membership of the country of the IBAN.
    
    Returns:
    true, if the country of the IBAN is a member of the Single Euro Payments Area; false, else.
  - getBankIdentifier
```
public String getBankIdentifier()
```
    Gets the bank identifier part of the BBAN of the IBAN.
    
    Returns:
    The bank identifier part of the BBAN of the IBAN.
  - getBranchIdentifier
```
public String getBranchIdentifier()
```
    Gets the branch identifier part of the BBAN of the IBAN.
    
    Returns:
    The branch identifier part of the BBAN of the IBAN or null.
  - parse
```
public static IBAN parse(String countryCode,
         String bban)
                  throws IbanSyntaxException
```
    Parses text from a BBAN string to produce an IBAN instance.
    
    Parameters:
    countryCode - The two-letter ISO 3166-1 country code of the IBAN to create.
    bban - A string to parse BBAN characters from.
    
    Returns:
    The parsed value.
    
    Throws:
    
    NullPointerException - if countryCode or bban is null.
    
    IllegalArgumentException - if the country denoted by countryCode has not implemented the IBAN standard, that is, countryCode is not contained in the array returned by method getCountryCodes.
    
    IbanSyntaxException - if the parse fails or the length of bban is invalid.
    See Also:
    getCountryCodes()
  - parse
```
public static IBAN parse(String text,
         ParsePosition pos)
                  throws IbanCheckDigitsException
```
    Parses text from a string to produce an IBAN instance.
    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:
    text - A string to parse IBAN characters from.
    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 text or pos is null.
    
    IbanCheckDigitsException - if check digits validation of the parsed value fails.
  - parse
```
public static IBAN parse(String text)
                  throws IbanSyntaxException,
                         IbanCheckDigitsException
```
    Parses text from the beginning of the given string to produce an IBAN instance.
    Unlike the parse(String, ParsePosition) method this method throws an IbanSyntaxException if text cannot be parsed or is of invalid length.
    
    Parameters:
    text - A string to parse IBAN characters from.
    
    Returns:
    The parsed value.
    
    Throws:
    
    NullPointerException - if text is null.
    
    IbanSyntaxException - if the parse fails or the length of text is invalid.
    
    IbanCheckDigitsException - if check digits validation of the parsed value fails.
    See Also:
    valueOf(java.lang.String)
  - valueOf
```
public static IBAN valueOf(String text)
```
    Parses text from the beginning of the given string to produce an IBAN instance.
    Unlike the parse(String) method this method throws an IllegalArgumentException if text cannot be parsed, is of invalid length or check digits validation fails.
    
    Parameters:
    text - A string to parse IBAN characters from.
    
    Returns:
    The parsed value.
    
    Throws:
    
    NullPointerException - if text is null.
    
    IllegalArgumentException - if the parse fails, the length of text is invalid or if check digits validation of the parsed value fails.
    See Also:
    parse(java.lang.String)
  - isIbanAlphabet
```
public static boolean isIbanAlphabet(char c)
```
    Checks a given character to belong to the IBAN alphabet.
    
    Parameters:
    c - The character to check.
    
    Returns:
    true if c is a character of the IBAN alphabet; false, else.
  - peekIban
```
public static boolean peekIban(String text)
                        throws IbanCheckDigitsException
```
    Parses text from a string to peek at a national IBAN format.
    This method peeks at the given string to test whether it denotes a possibly valid national IBAN format.
    
    Parameters:
    text - A string to peek at.
    
    Returns:
    true, if text denotes a (possibly partially) valid national IBAN format; false, if text does not denote a valid national IBAN format.
    
    Throws:
    
    NullPointerException - if text is null.
    
    IbanCheckDigitsException - if check digits validation fails.
  - append
```
public Appendable append(IbanFormat format,
                Appendable appendable)
                  throws IOException
```
    Formats an IBAN and appends the resulting text to a given Appendable.
    
    Parameters:
    format - The format to use.
    appendable - The Appendable to append the formatted IBAN to.
    
    Returns:
    The value passed in as appendable.
    
    Throws:
    
    NullPointerException - if format or appendable is null.
    
    IOException - if appending fails.
  - toString
```
public String toString(IbanFormat format)
```
    Formats an IBAN to produce a string.
    
    Parameters:
    format - The format to use.
    
    Returns:
    The formatted string.
    
    Throws:
    
    NullPointerException - if format is null.
  - formatTo
```
public void formatTo(Formatter formatter,
            int flags,
            int width,
            int precision)
```
    Formats the object using the provided Formatter.
    This method uses the ELECTRONIC format by default. The PRINT format can be used by specifying the alternate form flag (#) in a format specifier.
    
    Specified by:
    
    formatTo in interface Formattable
    
    Parameters:
    formatter - The Formatter.
    flags - The flags to modify the output format.
    width - The minimum number of characters to be written to the output.
    precision - The maximum number of characters to be written to the output.
    
    Throws:
    
    IllegalFormatFlagsException - if the UPPERCASE flag is set.
  - length
```
public int length()
```
    Returns the length of this character sequence.
    The length is the number of 16-bit chars in the sequence.
    
    Specified by:
    
    length in interface CharSequence
    
    Returns:
    The number of chars in this sequence.
  - charAt
```
public char charAt(int index)
```
    Returns the char value at the specified index.
    An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.
    
    If the char value specified by the index is a surrogate, the surrogate value is returned.
    
    Specified by:
    
    charAt in interface CharSequence
    
    Parameters:
    index - The index of the char value to return.
    
    Returns:
    The char value at index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or not less than the length of the character sequence.
    See Also:
    length()
  - subSequence
```
public CharSequence subSequence(int start,
                       int end)
```
    Returns a new CharSequence that is a subsequence of this sequence.
    The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.
    
    Specified by:
    
    subSequence in interface CharSequence
    
    Parameters:
    start - The start index, inclusive.
    end - The end index, exclusive.
    
    Returns:
    The subsequence starting at start up to end -1.
    
    Throws:
    
    IndexOutOfBoundsException - if start or end are negative, if end is greater than the length of the character sequence, or if start is greater than end.
  - hashCode
```
public int hashCode()
```
    Gets the hash code value of the object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    The hash code value of the object.
  - 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.
  - toString
```
public String toString()
```
    Gets a string representation of the object.
    
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of the object.
  - compareTo
```
public int compareTo(IBAN o)
```
    Compares this object with the specified object for order.
    IBAN comparison respects the national IBAN formats when comparing IBANs of the same country. Any country codes and check digits are ignored.
    
    Specified by:
    
    compareTo in interface Comparable<IBAN>
    
    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.

Class IBAN

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_CHARACTERS

Method Detail

getCountryCodes

getCountryCode

isSepaCountry

getBankIdentifier

getBranchIdentifier

parse

parse

parse

valueOf

isIbanAlphabet

peekIban

append

toString

formatTo

length

charAt

subSequence

hashCode

equals

toString

compareTo