Package org.iban4j

Class Iban.Builder

java.lang.Object

org.iban4j.Iban.Builder

Enclosing class:

Iban

public static final class Iban.Builder
extends Object

Iban Builder Class

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates an Iban Builder instance.
Builder(Random random)	Creates an Iban Builder instance.

Method Summary

Modifier and Type	Method	Description
Iban.Builder	accountNumber(String accountNumber)	Sets iban's account number.
Iban.Builder	accountType(String accountType)	Sets iban's account type.
Iban.Builder	bankCode(String bankCode)	Sets iban's bank code.
Iban.Builder	branchCode(String branchCode)	Sets iban's branch code.
Iban	build()	Builds new iban instance.
Iban	build(boolean validate)	Builds new iban instance.
Iban	buildRandom()	Builds random iban instance.
Iban.Builder	countryCode(CountryCode countryCode)	Sets iban's country code.
Iban.Builder	identificationNumber(String identificationNumber)	Sets iban's identification number.
Iban.Builder	leftPadding(boolean enableLeftPadding)	Sets iban's left zero padding flag
Iban.Builder	nationalCheckDigit(String nationalCheckDigit)	Sets iban's national check digit.
Iban.Builder	ownerAccountType(String ownerAccountType)	Sets iban's owner account type.
Iban.Builder	paddingCharacter(char paddingCharacter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(Random random)

Creates an Iban Builder instance.

Builder

public Builder()

Creates an Iban Builder instance.

Method Details

countryCode

public Iban.Builder countryCode(CountryCode countryCode)

Sets iban's country code.

Parameters:

countryCode - CountryCode

Returns:

builder Builder

bankCode

public Iban.Builder bankCode(String bankCode)

Sets iban's bank code.

Parameters:

bankCode - String

Returns:

builder Builder

branchCode

public Iban.Builder branchCode(String branchCode)

Sets iban's branch code.

Parameters:

branchCode - String

Returns:

builder Builder

accountNumber

public Iban.Builder accountNumber(String accountNumber)

Sets iban's account number.

Parameters:

accountNumber - String

Returns:

builder Builder

nationalCheckDigit

public Iban.Builder nationalCheckDigit(String nationalCheckDigit)

Sets iban's national check digit.

Parameters:

nationalCheckDigit - String

Returns:

builder Builder

accountType

public Iban.Builder accountType(String accountType)

Sets iban's account type.

Parameters:

accountType - String

Returns:

builder Builder

ownerAccountType

public Iban.Builder ownerAccountType(String ownerAccountType)

Sets iban's owner account type.

Parameters:

ownerAccountType - String

Returns:

builder Builder

identificationNumber

public Iban.Builder identificationNumber(String identificationNumber)

Sets iban's identification number.

Parameters:

identificationNumber - String

Returns:

builder Builder

leftPadding

public Iban.Builder leftPadding(boolean enableLeftPadding)

Sets iban's left zero padding flag

Parameters:

enableLeftPadding - used to determine must left pad or not, default value is false

Returns:

builder Builder

paddingCharacter

public Iban.Builder paddingCharacter(char paddingCharacter)

Parameters:

paddingCharacter - which is going to replace the default one which is '0'

Returns:

builder Builder

build

public Iban build()
           throws IbanFormatException,
IllegalArgumentException,
UnsupportedCountryException

Builds new iban instance. This method validates the generated IBAN.

Returns:

new iban instance.

Throws:

IbanFormatException - if values are not parsable by Iban Specification ISO_13616

UnsupportedCountryException - if country is not supported

IllegalArgumentException

build

public Iban build(boolean validate)
           throws IbanFormatException,
IllegalArgumentException,
UnsupportedCountryException

Builds new iban instance.

Parameters:

validate - boolean indicates if the generated IBAN needs to be validated after generation

Returns:

new iban instance.

Throws:

IbanFormatException - if values are not parsable by Iban Specification ISO_13616

UnsupportedCountryException - if country is not supported

IllegalArgumentException

buildRandom

public Iban buildRandom()
                 throws IbanFormatException,
IllegalArgumentException,
UnsupportedCountryException

Builds random iban instance.

Returns:

random iban instance.

Throws:

IbanFormatException - if values are not parsable by Iban Specification ISO_13616

UnsupportedCountryException - if country is not supported

IllegalArgumentException