Iban (iban4j 3.2.2 API)

java.lang.Object
- org.iban4j.Iban

```
public final class Iban
extends Object
```
International Bank Account Number ISO_13616.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Iban.Builder
Iban Builder Class

Nested Classes
Modifier and Type	Class and Description
`static class`	`Iban.Builder` Iban Builder Class

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAccountNumber()` Returns iban's account number.
`String`	`getAccountType()` Returns iban's account type.
`String`	`getBankCode()` Returns iban's bank code.
`String`	`getBban()` Returns iban's bban (Basic Bank Account Number).
`String`	`getBranchCode()` Returns iban's branch code.
`String`	`getCheckDigit()` Returns iban's check digit.
`CountryCode`	`getCountryCode()` Returns iban's country code.
`String`	`getIdentificationNumber()` Returns iban's identification number.
`String`	`getNationalCheckDigit()` Returns iban's national check digit.
`String`	`getOwnerAccountType()` Returns iban's owner account type.
`int`	`hashCode()`
`static Iban`	`random()`
`static Iban`	`random(CountryCode cc)`
`String`	`toFormattedString()` Returns formatted version of Iban.
`String`	`toString()`
`static Iban`	`valueOf(String iban)` Returns an Iban object holding the value of the specified String.
`static Iban`	`valueOf(String iban, IbanFormat format)` Returns an Iban object holding the value of the specified String.

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

- Method Detail
  - getCountryCode
```
public CountryCode getCountryCode()
```
    Returns iban's country code.
    
    Returns:
    
    countryCode CountryCode
  - getCheckDigit
```
public String getCheckDigit()
```
    Returns iban's check digit.
    
    Returns:
    
    checkDigit String
  - getAccountNumber
```
public String getAccountNumber()
```
    Returns iban's account number.
    
    Returns:
    
    accountNumber String
  - getBankCode
```
public String getBankCode()
```
    Returns iban's bank code.
    
    Returns:
    
    bankCode String
  - getBranchCode
```
public String getBranchCode()
```
    Returns iban's branch code.
    
    Returns:
    
    branchCode String
  - getNationalCheckDigit
```
public String getNationalCheckDigit()
```
    Returns iban's national check digit.
    
    Returns:
    
    nationalCheckDigit String
  - getAccountType
```
public String getAccountType()
```
    Returns iban's account type.
    
    Returns:
    
    accountType String
  - getOwnerAccountType
```
public String getOwnerAccountType()
```
    Returns iban's owner account type.
    
    Returns:
    
    ownerAccountType String
  - getIdentificationNumber
```
public String getIdentificationNumber()
```
    Returns iban's identification number.
    
    Returns:
    
    identificationNumber String
  - getBban
```
public String getBban()
```
    Returns iban's bban (Basic Bank Account Number).
    
    Returns:
    
    bban String
  - valueOf
```
public static Iban valueOf(String iban)
                    throws IbanFormatException,
                           InvalidCheckDigitException,
                           UnsupportedCountryException
```
    Returns an Iban object holding the value of the specified String.
    
    Parameters:
    
    iban - the String to be parsed.
    
    Returns:
    
    an Iban object holding the value represented by the string argument.
    
    Throws:
    
    IbanFormatException - if the String doesn't contain parsable Iban InvalidCheckDigitException if Iban has invalid check digit UnsupportedCountryException if Iban's Country is not supported.
    
    InvalidCheckDigitException
    
    UnsupportedCountryException
  - valueOf
```
public static Iban valueOf(String iban,
                           IbanFormat format)
                    throws IbanFormatException,
                           InvalidCheckDigitException,
                           UnsupportedCountryException
```
    Returns an Iban object holding the value of the specified String.
    
    Parameters:
    
    iban - the String to be parsed.
    
    format - the format of the Iban.
    
    Returns:
    
    an Iban object holding the value represented by the string argument.
    
    Throws:
    
    IbanFormatException - if the String doesn't contain parsable Iban InvalidCheckDigitException if Iban has invalid check digit UnsupportedCountryException if Iban's Country is not supported.
    
    InvalidCheckDigitException
    
    UnsupportedCountryException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toFormattedString
```
public String toFormattedString()
```
    Returns formatted version of Iban.
    
    Returns:
    
    A string representing formatted Iban for printing.
  - random
```
public static Iban random()
```
  - random
```
public static Iban random(CountryCode cc)
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Iban

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCountryCode

getCheckDigit

getAccountNumber

getBankCode

getBranchCode

getNationalCheckDigit

getAccountType

getOwnerAccountType

getIdentificationNumber

getBban

valueOf

valueOf

toString

toFormattedString

random

random

equals

hashCode