From deb4e6555ff9594d2211ba38fcba777f3a5e5d54 Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Wed, 6 Jul 2022 18:24:02 +0200 Subject: [PATCH] Improve javadoc (closes #121) - add examples, - add documentation on packages, - add an overview, - fix javadoc warnings, - minor improvements and type fixes. --- CHANGELOG.md | 1 + README.md | 26 +- .../fr/marcwrobel/jbanking/IsoCountry.java | 328 +++++++++--------- .../fr/marcwrobel/jbanking/IsoCurrency.java | 16 + .../java/fr/marcwrobel/jbanking/bic/Bic.java | 23 +- .../jbanking/bic/BicFormatException.java | 7 +- .../marcwrobel/jbanking/bic/package-info.java | 4 + .../jbanking/calendar/BridgedHoliday.java | 7 + .../jbanking/calendar/Calendar.java | 34 +- .../marcwrobel/jbanking/calendar/Holiday.java | 8 +- .../jbanking/calendar/WesternEaster.java | 3 + .../jbanking/calendar/package-info.java | 6 + .../jbanking/creditor/CreditorIdentifier.java | 23 +- .../CreditorIdentifierFormatException.java | 3 + .../jbanking/creditor/package-info.java | 5 + .../fr/marcwrobel/jbanking/iban/Iban.java | 21 +- .../jbanking/iban/IbanCheckDigit.java | 3 + .../jbanking/iban/IbanFormatException.java | 3 + .../jbanking/iban/package-info.java | 5 + .../fr/marcwrobel/jbanking/package-info.java | 18 + .../jbanking/swift/SwiftPattern.java | 17 +- .../swift/SwiftPatternSyntaxException.java | 3 + .../jbanking/swift/package-info.java | 4 + src/main/javadoc/overview.html | 67 ++++ 24 files changed, 454 insertions(+), 181 deletions(-) create mode 100644 src/main/java/fr/marcwrobel/jbanking/bic/package-info.java create mode 100644 src/main/java/fr/marcwrobel/jbanking/calendar/package-info.java create mode 100644 src/main/java/fr/marcwrobel/jbanking/creditor/package-info.java create mode 100644 src/main/java/fr/marcwrobel/jbanking/iban/package-info.java create mode 100644 src/main/java/fr/marcwrobel/jbanking/package-info.java create mode 100644 src/main/java/fr/marcwrobel/jbanking/swift/package-info.java create mode 100644 src/main/javadoc/overview.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 22cb7cf..ecbc3d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - Update NYSE and New York FED calendars following [Juneteenth National Independence Day Act](https://www.cnbc.com/2021/06/17/juneteenth-federal-holiday-biden-signs-bill.html) (#98). +- Improve documentation: add examples, documentation on packages, an overview and fix typos (#121). ### Fixed diff --git a/README.md b/README.md index 3737394..1983bbe 100644 --- a/README.md +++ b/README.md @@ -17,26 +17,26 @@ limited to, European banking. jbanking is supporting the following features : -* [ISO 3166-1 countries](http://wikipedia.org/wiki/ISO_3166-1) (with alpha-2 code, alpha-3 code, numeric code and status - - e.g. independent or dependent according to the [International Organization for Standardization](https://www.iso.org)). -* Countries' or territories' participation to economic agreements : - * [European Economic Area (EEA)](https://wikipedia.org/wiki/European_Economic_Area) - * [European Free Trade Association (EFTA)](https://wikipedia.org/wiki/European_Free_Trade_Association) - * [European Union (EU)](https://en.wikipedia.org/wiki/European_Union) - * [SEPA COM Pacifique](https://www.cfonb.org/Default.aspx?lid=1&rid=122&rvid=239) - * [Single Euro Payments Area (SEPA)](https://wikipedia.org/wiki/Single_Euro_Payments_Area) +* [ISO 3166-1 countries](http://wikipedia.org/wiki/ISO_3166-1) with alpha-2 code, alpha-3 code, numeric code and status, + e.g. independent or dependent (according to the [International Organization for Standardization](https://www.iso.org)). +* Countries or territories participation to economic agreements : + * [European Economic Area (EEA)](https://wikipedia.org/wiki/European_Economic_Area), + * [European Free Trade Association (EFTA)](https://wikipedia.org/wiki/European_Free_Trade_Association), + * [European Union (EU)](https://en.wikipedia.org/wiki/European_Union), + * [SEPA COM Pacifique](https://www.cfonb.org/Default.aspx?lid=1&rid=122&rvid=239), + * [Single Euro Payments Area (SEPA)](https://wikipedia.org/wiki/Single_Euro_Payments_Area). * [ISO 4217 currencies](http://wikipedia.org/wiki/ISO_4217) (with alphabetic code, numeric code, minor unit and countries using it). * [ISO 9362:2009 BIC](http://wikipedia.org/wiki/Bank_Identifier_Code) handling and validation. * [ISO 13616:2007 IBAN](http://wikipedia.org/wiki/International_Bank_Account_Number) handling and validation (for both - checkdigit and national bank account number structure). + check digit and national bank account number structure). * [Creditor Identifiers (CIs)](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/creditor-identifier-overview) handling and validation. * Configurable [holiday](https://wikipedia.org/wiki/Holiday) calendar support with predefined calendars for : - * Frankfurt, London, Paris, Sydney, and Tokyo financial districts - * Federal Reserve Bank of New York (FED) - * New York Stock Exchange (NYSE) - * European Union TARGET system + * Frankfurt, London, Paris, Sydney, and Tokyo financial districts, + * Federal Reserve Bank of New York (FED), + * New York Stock Exchange (NYSE), + * European Union TARGET system. ## Requirements diff --git a/src/main/java/fr/marcwrobel/jbanking/IsoCountry.java b/src/main/java/fr/marcwrobel/jbanking/IsoCountry.java index 910d6f0..4da6356 100644 --- a/src/main/java/fr/marcwrobel/jbanking/IsoCountry.java +++ b/src/main/java/fr/marcwrobel/jbanking/IsoCountry.java @@ -31,33 +31,45 @@ * Please be advised that this list is current as of 2020-08-03. An up-to-date list can be found on the * International Organization for Standardization website. * + *

+ * Usage: + * + * 

+ * IsoCountry country = IsoCountry.fromAlpha2Code("FR").get();
+ *
+ * Assertion.assertEquals("FRA", country.getAlpha3Code());
+ * Assertion.assertEquals(250, country.getNumericCode());
+ * Assertion.assertTrue(country.isIndependent());
+ * Assertion.assertTrue(country.isParticipatingTo(EUROPEAN_ECONOMIC_AREA));
+ *
+ * * @see ISO 3166 Country Codes * @since 1.0 */ public enum IsoCountry { /** - * Afghanistan (a.k.a. the Islamic Republic of Afghanistan). + * Afghanistan (aka the Islamic Republic of Afghanistan). * * @see www.iso.org */ AF("AFG", 4), /** - * Albania (a.k.a. the Republic of Albania). + * Albania (aka the Republic of Albania). * * @see www.iso.org */ AL("ALB", 8), /** - * Algeria (a.k.a. the People's Democratic Republic of Algeria). + * Algeria (aka the People's Democratic Republic of Algeria). * * @see www.iso.org */ DZ("DZA", 12), /** - * Andorra (a.k.a. the Principality of Andorra). + * Andorra (aka the Principality of Andorra). * * @see www.iso.org */ @@ -85,14 +97,14 @@ public enum IsoCountry { AG("ATG", 28), /** - * Argentina (a.k.a. the Argentine Republic). + * Argentina (aka the Argentine Republic). * * @see www.iso.org */ AR("ARG", 32), /** - * Armenia (a.k.a. the Republic of Armenia). + * Armenia (aka the Republic of Armenia). * * @see www.iso.org */ @@ -134,7 +146,7 @@ public enum IsoCountry { NF("NFK", 574, AU), /** - * Austria (a.k.a. the Republic of Austria). + * Austria (aka the Republic of Austria). * * @see www.iso.org */ @@ -148,21 +160,21 @@ public enum IsoCountry { AZ("AZE", 31), /** - * The Bahamas (a.k.a. the Commonwealth of the Bahamas). + * The Bahamas (aka the Commonwealth of the Bahamas). * * @see www.iso.org */ BS("BHS", 44), /** - * Bahrain (a.k.a. the Kingdom of Bahrain). + * Bahrain (aka the Kingdom of Bahrain). * * @see www.iso.org */ BH("BHR", 48), /** - * Bangladesh (a.k.a. the People's Republic of Bangladesh). + * Bangladesh (aka the People's Republic of Bangladesh). * * @see www.iso.org */ @@ -176,14 +188,14 @@ public enum IsoCountry { BB("BRB", 52), /** - * Belarus (a.k.a. the Republic of Belarus). + * Belarus (aka the Republic of Belarus). * * @see www.iso.org */ BY("BLR", 112), /** - * Belgium (a.k.a. the Kingdom of Belgium). + * Belgium (aka the Kingdom of Belgium). * * @see www.iso.org */ @@ -197,21 +209,21 @@ public enum IsoCountry { BZ("BLZ", 84), /** - * Benin (a.k.a. the Republic of Benin). + * Benin (aka the Republic of Benin). * * @see www.iso.org */ BJ("BEN", 204), /** - * Bhutan (a.k.a. the Kingdom of Bhutan). + * Bhutan (aka the Kingdom of Bhutan). * * @see www.iso.org */ BT("BTN", 64), /** - * Bolivia (a.k.a. the Plurinational State of Bolivia). + * Bolivia (aka the Plurinational State of Bolivia). * * @see www.iso.org */ @@ -225,7 +237,7 @@ public enum IsoCountry { BA("BIH", 70), /** - * Botswana (a.k.a. the Republic of Botswana). + * Botswana (aka the Republic of Botswana). * * @see www.iso.org */ @@ -260,21 +272,21 @@ public enum IsoCountry { BF("BFA", 854), /** - * Burundi (a.k.a. the Republic of Burundi). + * Burundi (aka the Republic of Burundi). * * @see www.iso.org */ BI("BDI", 108), /** - * Cambodia (a.k.a. the Kingdom of Cambodia). + * Cambodia (aka the Kingdom of Cambodia). * * @see www.iso.org */ KH("KHM", 116), /** - * Cameroon (a.k.a. the Republic of Cameroon). + * Cameroon (aka the Republic of Cameroon). * * @see www.iso.org */ @@ -288,7 +300,7 @@ public enum IsoCountry { CA("CAN", 124), /** - * Cabo Verde (a.k.a. the Republic of Cabo Verde). + * Cabo Verde (aka the Republic of Cabo Verde). * * @see www.iso.org */ @@ -302,28 +314,28 @@ public enum IsoCountry { CF("CAF", 140), /** - * Chad (a.k.a. the Republic of Chad). + * Chad (aka the Republic of Chad). * * @see www.iso.org */ TD("TCD", 148), /** - * Chile (a.k.a. the Republic of Chile). + * Chile (aka the Republic of Chile). * * @see www.iso.org */ CL("CHL", 152), /** - * China (a.k.a. the People's Republic of China). + * China (aka the People's Republic of China). * * @see www.iso.org */ CN("CHN", 156), /** - * Hong Kong (a.k.a. the Hong Kong Special Administrative Region of China). + * Hong Kong (aka the Hong Kong Special Administrative Region of China). * * @see www.iso.org */ @@ -337,28 +349,28 @@ public enum IsoCountry { MO("MAC", 446, CN), /** - * Colombia (a.k.a. the Republic of Colombia). + * Colombia (aka the Republic of Colombia). * * @see www.iso.org */ CO("COL", 170), /** - * The Comoros (a.k.a. the Union of the Comoros). + * The Comoros (aka the Union of the Comoros). * * @see www.iso.org */ KM("COM", 174), /** - * The Congo (a.k.a. the Republic of the Congo). + * The Congo (aka the Republic of the Congo). * * @see www.iso.org */ CG("COG", 178), /** - * Costa Rica (a.k.a. the Republic of Costa Rica). + * Costa Rica (aka the Republic of Costa Rica). * * @see www.iso.org */ @@ -372,35 +384,35 @@ public enum IsoCountry { CI("CIV", 384), /** - * Croatia (a.k.a. the Republic of Croatia). + * Croatia (aka the Republic of Croatia). * * @see www.iso.org */ HR("HRV", 191), /** - * Cuba (a.k.a. the Republic of Cuba). + * Cuba (aka the Republic of Cuba). * * @see www.iso.org */ CU("CUB", 192), /** - * Cyprus (a.k.a. the Republic of Cyprus). + * Cyprus (aka the Republic of Cyprus). * * @see www.iso.org */ CY("CYP", 196), /** - * Czechia (a.k.a. the Czech Republic). + * Czechia (aka the Czech Republic). * * @see www.iso.org */ CZ("CZE", 203), /** - * Denmark (a.k.a. the Kingdom of Denmark). + * Denmark (aka the Kingdom of Denmark). * * @see www.iso.org */ @@ -421,14 +433,14 @@ public enum IsoCountry { GL("GRL", 304, DK), /** - * Djibouti (a.k.a. the Republic of Djibouti). + * Djibouti (aka the Republic of Djibouti). * * @see www.iso.org */ DJ("DJI", 262), /** - * Dominica (a.k.a. the Commonwealth of Dominica). + * Dominica (aka the Commonwealth of Dominica). * * @see www.iso.org */ @@ -442,63 +454,63 @@ public enum IsoCountry { DO("DOM", 214), /** - * Ecuador (a.k.a. the Republic of Ecuador). + * Ecuador (aka the Republic of Ecuador). * * @see www.iso.org */ EC("ECU", 218), /** - * Egypt (a.k.a. the Arab Republic of Egypt). + * Egypt (aka the Arab Republic of Egypt). * * @see www.iso.org */ EG("EGY", 818), /** - * El Salvador (a.k.a. the Republic of El Salvador). + * El Salvador (aka the Republic of El Salvador). * * @see www.iso.org */ SV("SLV", 222), /** - * Equatorial Guinea (a.k.a. the Republic of Equatorial Guinea). + * Equatorial Guinea (aka the Republic of Equatorial Guinea). * * @see www.iso.org */ GQ("GNQ", 226), /** - * Eritrea (a.k.a. the State of Eritrea). + * Eritrea (aka the State of Eritrea). * * @see www.iso.org */ ER("ERI", 232), /** - * Estonia (a.k.a. the Republic of Estonia). + * Estonia (aka the Republic of Estonia). * * @see www.iso.org */ EE("EST", 233), /** - * Ethiopia (a.k.a. the Federal Democratic Republic of Ethiopia). + * Ethiopia (aka the Federal Democratic Republic of Ethiopia). * * @see www.iso.org */ ET("ETH", 231), /** - * Fiji (a.k.a. the Republic of Fiji). + * Fiji (aka the Republic of Fiji). * * @see www.iso.org */ FJ("FJI", 242), /** - * Finland (a.k.a. the Republic of Finland). + * Finland (aka the Republic of Finland). * * @see www.iso.org */ @@ -512,7 +524,7 @@ public enum IsoCountry { AX("ALA", 248, FI), /** - * France (a.k.a. the French Republic). + * France (aka the French Republic). * * @see www.iso.org */ @@ -596,21 +608,21 @@ public enum IsoCountry { PM("SPM", 666, FR), /** - * Wallis and Futuna (a.k.a. Wallis and Futuna Islands). + * Wallis and Futuna (aka Wallis and Futuna Islands). * * @see www.iso.org */ WF("WLF", 876, FR), /** - * Gabon (a.k.a. the Gabonese Republic). + * Gabon (aka the Gabonese Republic). * * @see www.iso.org */ GA("GAB", 266), /** - * The Gambia (a.k.a. the Republic of the Gambia). + * The Gambia (aka the Republic of the Gambia). * * @see www.iso.org */ @@ -624,21 +636,21 @@ public enum IsoCountry { GE("GEO", 268), /** - * Germany (a.k.a. the Federal Republic of Germany). + * Germany (aka the Federal Republic of Germany). * * @see www.iso.org */ DE("DEU", 276), /** - * Ghana (a.k.a. the Republic of Ghana). + * Ghana (aka the Republic of Ghana). * * @see www.iso.org */ GH("GHA", 288), /** - * Greece (a.k.a. the Hellenic Republic). + * Greece (aka the Hellenic Republic). * * @see www.iso.org */ @@ -652,42 +664,42 @@ public enum IsoCountry { GD("GRD", 308), /** - * Guatemala (a.k.a. the Republic of Guatemala). + * Guatemala (aka the Republic of Guatemala). * * @see www.iso.org */ GT("GTM", 320), /** - * Guinea (a.k.a. the Republic of Guinea). + * Guinea (aka the Republic of Guinea). * * @see www.iso.org */ GN("GIN", 324), /** - * Guinea-Bissau (a.k.a. the Republic of Guinea-Bissau). + * Guinea-Bissau (aka the Republic of Guinea-Bissau). * * @see www.iso.org */ GW("GNB", 624), /** - * Guyana (a.k.a. the Co-operative Republic of Guyana). + * Guyana (aka the Co-operative Republic of Guyana). * * @see www.iso.org */ GY("GUY", 328), /** - * Haiti (a.k.a. the Republic of Haiti). + * Haiti (aka the Republic of Haiti). * * @see www.iso.org */ HT("HTI", 332), /** - * Honduras (a.k.a. the Republic of Honduras). + * Honduras (aka the Republic of Honduras). * * @see www.iso.org */ @@ -701,21 +713,21 @@ public enum IsoCountry { HU("HUN", 348), /** - * Iceland (a.k.a. the Republic of Iceland). + * Iceland (aka the Republic of Iceland). * * @see www.iso.org */ IS("ISL", 352), /** - * India (a.k.a. the Republic of India). + * India (aka the Republic of India). * * @see www.iso.org */ IN("IND", 356), /** - * Indonesia (a.k.a. the Republic of Indonesia). + * Indonesia (aka the Republic of Indonesia). * * @see www.iso.org */ @@ -729,7 +741,7 @@ public enum IsoCountry { IR("IRN", 364), /** - * Iraq (a.k.a. the Republic of Iraq). + * Iraq (aka the Republic of Iraq). * * @see www.iso.org */ @@ -743,14 +755,14 @@ public enum IsoCountry { IE("IRL", 372), /** - * Israel (a.k.a. the State of Israel). + * Israel (aka the State of Israel). * * @see www.iso.org */ IL("ISR", 376), /** - * Italy (a.k.a. the Republic of Italy). + * Italy (aka the Republic of Italy). * * @see www.iso.org */ @@ -771,28 +783,28 @@ public enum IsoCountry { JP("JPN", 392), /** - * Jordan (a.k.a. the Hashemite Kingdom of Jordan). + * Jordan (aka the Hashemite Kingdom of Jordan). * * @see www.iso.org */ JO("JOR", 400), /** - * Kazakhstan (a.k.a. the Republic of Kazakhstan). + * Kazakhstan (aka the Republic of Kazakhstan). * * @see www.iso.org */ KZ("KAZ", 398), /** - * Kenya (a.k.a. the Republic of Kenya). + * Kenya (aka the Republic of Kenya). * * @see www.iso.org */ KE("KEN", 404), /** - * Kiribati (a.k.a. the Republic of Kiribati). + * Kiribati (aka the Republic of Kiribati). * * @see www.iso.org */ @@ -809,14 +821,14 @@ public enum IsoCountry { XK("XKX", null), /** - * Kuwait (a.k.a. the State of Kuwait). + * Kuwait (aka the State of Kuwait). * * @see www.iso.org */ KW("KWT", 414), /** - * Kyrgyzstan (a.k.a. the Kyrgyz Republic). + * Kyrgyzstan (aka the Kyrgyz Republic). * * @see www.iso.org */ @@ -830,77 +842,77 @@ public enum IsoCountry { LA("LAO", 418), /** - * Latvia (a.k.a. the Republic of Latvia). + * Latvia (aka the Republic of Latvia). * * @see www.iso.org */ LV("LVA", 428), /** - * Lebanon (a.k.a. the Lebanese Republic). + * Lebanon (aka the Lebanese Republic). * * @see www.iso.org */ LB("LBN", 422), /** - * Lesotho (a.k.a. the Kingdom of Lesotho). + * Lesotho (aka the Kingdom of Lesotho). * * @see www.iso.org */ LS("LSO", 426), /** - * Liberia (a.k.a. the Republic of Liberia). + * Liberia (aka the Republic of Liberia). * * @see www.iso.org */ LR("LBR", 430), /** - * Libya (a.k.a. the State of Libya). + * Libya (aka the State of Libya). * * @see www.iso.org */ LY("LBY", 434), /** - * Liechtenstein (a.k.a. the Principality of Liechtenstein). + * Liechtenstein (aka the Principality of Liechtenstein). * * @see www.iso.org */ LI("LIE", 438), /** - * Lithuania (a.k.a. the Republic of Lithuania). + * Lithuania (aka the Republic of Lithuania). * * @see www.iso.org */ LT("LTU", 440), /** - * Luxembourg (a.k.a. the Grand Duchy of Luxembourg). + * Luxembourg (aka the Grand Duchy of Luxembourg). * * @see www.iso.org */ LU("LUX", 442), /** - * North Macedonia (a.k.a. the Republic of North Macedonia). + * North Macedonia (aka the Republic of North Macedonia). * * @see www.iso.org */ MK("MKD", 807), /** - * Madagascar (a.k.a. the Republic of Madagascar). + * Madagascar (aka the Republic of Madagascar). * * @see www.iso.org */ MG("MDG", 450), /** - * Malawi (a.k.a. the Republic of Malawi). + * Malawi (aka the Republic of Malawi). * * @see www.iso.org */ @@ -914,49 +926,49 @@ public enum IsoCountry { MY("MYS", 458), /** - * Maldives (a.k.a. the Republic of Maldives). + * Maldives (aka the Republic of Maldives). * * @see www.iso.org */ MV("MDV", 462), /** - * Mali (a.k.a. the Republic of Mali). + * Mali (aka the Republic of Mali). * * @see www.iso.org */ ML("MLI", 466), /** - * Malta (a.k.a. the Republic of Malta). + * Malta (aka the Republic of Malta). * * @see www.iso.org */ MT("MLT", 470), /** - * The Marshall Islands (a.k.a. the Republic of the Marshall Islands). + * The Marshall Islands (aka the Republic of the Marshall Islands). * * @see www.iso.org */ MH("MHL", 584), /** - * Mauritania (a.k.a. the Islamic Republic of Mauritania). + * Mauritania (aka the Islamic Republic of Mauritania). * * @see www.iso.org */ MR("MRT", 478), /** - * Mauritius (a.k.a. the Republic of Mauritius). + * Mauritius (aka the Republic of Mauritius). * * @see www.iso.org */ MU("MUS", 480), /** - * Mexico (a.k.a. the United Mexican States). + * Mexico (aka the United Mexican States). * * @see www.iso.org */ @@ -977,7 +989,7 @@ public enum IsoCountry { MD("MDA", 498), /** - * Monaco (a.k.a. the Principality of Monaco). + * Monaco (aka the Principality of Monaco). * * @see www.iso.org */ @@ -998,49 +1010,49 @@ public enum IsoCountry { ME("MNE", 499), /** - * Morocco (a.k.a. the Kingdom of Morocco). + * Morocco (aka the Kingdom of Morocco). * * @see www.iso.org */ MA("MAR", 504), /** - * Mozambique (a.k.a. the Republic of Mozambique). + * Mozambique (aka the Republic of Mozambique). * * @see www.iso.org */ MZ("MOZ", 508), /** - * Myanmar (a.k.a. the Republic of the Union of Myanmar). + * Myanmar (aka the Republic of the Union of Myanmar). * * @see www.iso.org */ MM("MMR", 104), /** - * Namibia (a.k.a. the Republic of Namibia). + * Namibia (aka the Republic of Namibia). * * @see www.iso.org */ NA("NAM", 516), /** - * Nauru (a.k.a. the Republic of Nauru). + * Nauru (aka the Republic of Nauru). * * @see www.iso.org */ NR("NRU", 520), /** - * Nepal (a.k.a. the Federal Democratic Republic of Nepal). + * Nepal (aka the Federal Democratic Republic of Nepal). * * @see www.iso.org */ NP("NPL", 524), /** - * The Netherlands (a.k.a. the Kingdom of the Netherlands). + * The Netherlands (aka the Kingdom of the Netherlands). * * @see www.iso.org */ @@ -1103,35 +1115,35 @@ public enum IsoCountry { TK("TKL", 772, NZ), /** - * Nicaragua (a.k.a. the Republic of Nicaragua). + * Nicaragua (aka the Republic of Nicaragua). * * @see www.iso.org */ NI("NIC", 558), /** - * The Niger (a.k.a. the Republic of the Niger). + * The Niger (aka the Republic of the Niger). * * @see www.iso.org */ NE("NER", 562), /** - * Nigeria (a.k.a. the Federal Republic of Nigeria). + * Nigeria (aka the Federal Republic of Nigeria). * * @see www.iso.org */ NG("NGA", 566), /** - * The Democratic People's Republic of Korea (a.k.a. North Korea). + * The Democratic People's Republic of Korea (aka North Korea). * * @see www.iso.org */ KP("PRK", 408), /** - * Norway (a.k.a. the Kingdom of Norway). + * Norway (aka the Kingdom of Norway). * * @see www.iso.org */ @@ -1152,21 +1164,21 @@ public enum IsoCountry { SJ("SJM", 744, NO), /** - * Oman (a.k.a. the Sultanate of Oman). + * Oman (aka the Sultanate of Oman). * * @see www.iso.org */ OM("OMN", 512), /** - * Pakistan (a.k.a. the Islamic Republic of Pakistan). + * Pakistan (aka the Islamic Republic of Pakistan). * * @see www.iso.org */ PK("PAK", 586), /** - * Palau (a.k.a. the Republic of Palau). + * Palau (aka the Republic of Palau). * * @see www.iso.org */ @@ -1180,56 +1192,56 @@ public enum IsoCountry { PS("PSE", 275, null), /** - * Panama (a.k.a. the Republic of Panama). + * Panama (aka the Republic of Panama). * * @see www.iso.org */ PA("PAN", 591), /** - * Papua New Guinea (a.k.a. the Independent State of Papua New Guinea). + * Papua New Guinea (aka the Independent State of Papua New Guinea). * * @see www.iso.org */ PG("PNG", 598), /** - * Paraguay (a.k.a. the Republic of Paraguay). + * Paraguay (aka the Republic of Paraguay). * * @see www.iso.org */ PY("PRY", 600), /** - * Peru (a.k.a. the Republic of Peru). + * Peru (aka the Republic of Peru). * * @see www.iso.org */ PE("PER", 604), /** - * The Philippines (a.k.a. the Republic of the Philippines). + * The Philippines (aka the Republic of the Philippines). * * @see www.iso.org */ PH("PHL", 608), /** - * Poland (a.k.a. the Republic of Poland). + * Poland (aka the Republic of Poland). * * @see www.iso.org */ PL("POL", 616), /** - * Portugal (a.k.a. the Portuguese Republic). + * Portugal (aka the Portuguese Republic). * * @see www.iso.org */ PT("PRT", 620), /** - * Qatar (a.k.a. the State of Qatar). + * Qatar (aka the State of Qatar). * * @see www.iso.org */ @@ -1243,14 +1255,14 @@ public enum IsoCountry { RO("ROU", 642), /** - * The Russian Federation (a.k.a. Russia). + * The Russian Federation (aka Russia). * * @see www.iso.org */ RU("RUS", 643), /** - * Rwanda (a.k.a. the Republic of Rwanda). + * Rwanda (aka the Republic of Rwanda). * * @see www.iso.org */ @@ -1278,77 +1290,77 @@ public enum IsoCountry { VC("VCT", 670), /** - * Samoa (a.k.a. the Independent State of Samoa). + * Samoa (aka the Independent State of Samoa). * * @see www.iso.org */ WS("WSM", 882), /** - * San Marino (a.k.a. the Republic of San Marino). + * San Marino (aka the Republic of San Marino). * * @see www.iso.org */ SM("SMR", 674), /** - * São Tomé and Príncipe (a.k.a. the Democratic Republic of São Tomé and Príncipe). + * São Tomé and Príncipe (aka the Democratic Republic of São Tomé and Príncipe). * * @see www.iso.org */ ST("STP", 678), /** - * Saudi Arabia (a.k.a. the Kingdom of Saudi Arabia). + * Saudi Arabia (aka the Kingdom of Saudi Arabia). * * @see www.iso.org */ SA("SAU", 682), /** - * Senegal (a.k.a. the Republic of Senegal). + * Senegal (aka the Republic of Senegal). * * @see www.iso.org */ SN("SEN", 686), /** - * Serbia (a.k.a. the Republic of Serbia). + * Serbia (aka the Republic of Serbia). * * @see www.iso.org */ RS("SRB", 688), /** - * Seychelles (a.k.a. the Republic of Seychelles). + * Seychelles (aka the Republic of Seychelles). * * @see www.iso.org */ SC("SYC", 690), /** - * Sierra Leone (a.k.a. the Republic of Sierra Leone). + * Sierra Leone (aka the Republic of Sierra Leone). * * @see www.iso.org */ SL("SLE", 694), /** - * Singapore (a.k.a. the Republic of Singapore). + * Singapore (aka the Republic of Singapore). * * @see www.iso.org */ SG("SGP", 702), /** - * Slovakia (a.k.a. the Slovak Republic). + * Slovakia (aka the Slovak Republic). * * @see www.iso.org */ SK("SVK", 703), /** - * Slovenia (a.k.a. the Republic of Slovenia). + * Slovenia (aka the Republic of Slovenia). * * @see www.iso.org */ @@ -1362,77 +1374,77 @@ public enum IsoCountry { SB("SLB", 90), /** - * Somalia (a.k.a. the Federal Republic of Somalia). + * Somalia (aka the Federal Republic of Somalia). * * @see www.iso.org */ SO("SOM", 706), /** - * South Africa (a.k.a. the Republic of South Africa). + * South Africa (aka the Republic of South Africa). * * @see www.iso.org */ ZA("ZAF", 710), /** - * The Republic of Korea (a.k.a. South Korea). + * The Republic of Korea (aka South Korea). * * @see www.iso.org */ KR("KOR", 410), /** - * South Sudan (a.k.a. the Republic of South Sudan). + * South Sudan (aka the Republic of South Sudan). * * @see www.iso.org */ SS("SSD", 728), /** - * Spain (a.k.a. the Kingdom of Spain). + * Spain (aka the Kingdom of Spain). * * @see www.iso.org */ ES("ESP", 724), /** - * Sri Lanka (a.k.a. the Democratic Socialist Republic of Sri Lanka). + * Sri Lanka (aka the Democratic Socialist Republic of Sri Lanka). * * @see www.iso.org */ LK("LKA", 144), /** - * The Sudan (a.k.a. the Republic of the Sudan). + * The Sudan (aka the Republic of the Sudan). * * @see www.iso.org */ SD("SDN", 729), /** - * Suriname (a.k.a. the Republic of Suriname). + * Suriname (aka the Republic of Suriname). * * @see www.iso.org */ SR("SUR", 740), /** - * Eswatini (a.k.a. the Kingdom of Eswatini). + * Eswatini (aka the Kingdom of Eswatini). * * @see www.iso.org */ SZ("SWZ", 748), /** - * Sweden (a.k.a. the Kingdom of Sweden). + * Sweden (aka the Kingdom of Sweden). * * @see www.iso.org */ SE("SWE", 752), /** - * Switzerland (a.k.a. the Swiss Confederation). + * Switzerland (aka the Swiss Confederation). * * @see www.iso.org */ @@ -1453,7 +1465,7 @@ public enum IsoCountry { TW("TWN", 158, null), /** - * Tajikistan (a.k.a. the Republic of Tajikistan). + * Tajikistan (aka the Republic of Tajikistan). * * @see www.iso.org */ @@ -1467,7 +1479,7 @@ public enum IsoCountry { TZ("TZA", 834), /** - * Thailand (a.k.a. the Kingdom of Thailand). + * Thailand (aka the Kingdom of Thailand). * * @see www.iso.org */ @@ -1481,42 +1493,42 @@ public enum IsoCountry { CD("COD", 180), /** - * Timor-Leste (a.k.a. the Democratic Republic of Timor-Leste). + * Timor-Leste (aka the Democratic Republic of Timor-Leste). * * @see www.iso.org */ TL("TLS", 626), /** - * Togo (a.k.a. the Togolese Republic). + * Togo (aka the Togolese Republic). * * @see www.iso.org */ TG("TGO", 768), /** - * Tonga (a.k.a. the Kingdom of Tonga). + * Tonga (aka the Kingdom of Tonga). * * @see www.iso.org */ TO("TON", 776), /** - * Trinidad and Tobago (a.k.a. the Republic of Trinidad and Tobago). + * Trinidad and Tobago (aka the Republic of Trinidad and Tobago). * * @see www.iso.org */ TT("TTO", 780), /** - * Tunisia (a.k.a. the Republic of Tunisia). + * Tunisia (aka the Republic of Tunisia). * * @see www.iso.org */ TN("TUN", 788), /** - * Turkey (a.k.a. the Republic of Turkey). + * Turkey (aka the Republic of Turkey). * * @see www.iso.org */ @@ -1537,7 +1549,7 @@ public enum IsoCountry { TV("TUV", 798), /** - * Uganda (a.k.a. the Republic of Uganda). + * Uganda (aka the Republic of Uganda). * * @see www.iso.org */ @@ -1558,7 +1570,7 @@ public enum IsoCountry { AE("ARE", 784), /** - * The United Kingdom of Great Britain and Northern Ireland (a.k.a. the United Kingdom or Britain). + * The United Kingdom of Great Britain and Northern Ireland (aka the United Kingdom or Britain). * * @see www.iso.org */ @@ -1691,7 +1703,7 @@ public enum IsoCountry { GU("GUM", 316, US), /** - * The Northern Mariana Islands (a.k.a. the Commonwealth of the Northern Mariana Islands). + * The Northern Mariana Islands (aka the Commonwealth of the Northern Mariana Islands). * * @see www.iso.org */ @@ -1712,35 +1724,35 @@ public enum IsoCountry { UM("UMI", 581, US), /** - * The U.S. Virgin Islands (a.k.a. the Virgin Islands of the United States). + * The US Virgin Islands (aka the Virgin Islands of the United States). * * @see www.iso.org */ VI("VIR", 850, US), /** - * Uruguay (a.k.a. the Eastern Republic of Uruguay). + * Uruguay (aka the Eastern Republic of Uruguay). * * @see www.iso.org */ UY("URY", 858), /** - * Uzbekistan (a.k.a. the Republic of Uzbekistan). + * Uzbekistan (aka the Republic of Uzbekistan). * * @see www.iso.org */ UZ("UZB", 860), /** - * Vanuatu (a.k.a. the Republic of Vanuatu). + * Vanuatu (aka the Republic of Vanuatu). * * @see www.iso.org */ VU("VUT", 548), /** - * The Holy See (a.k.a. the Vatican City State). + * The Holy See (aka the Vatican City State). * * @see www.iso.org */ @@ -1754,7 +1766,7 @@ public enum IsoCountry { VE("VEN", 862), /** - * Viet Nam (a.k.a. the Socialist Republic of Viet Nam). + * Viet Nam (aka the Socialist Republic of Viet Nam). * * @see www.iso.org */ @@ -1768,21 +1780,21 @@ public enum IsoCountry { EH("ESH", 732, null), /** - * Yemen (a.k.a. the Republic of Yemen). + * Yemen (aka the Republic of Yemen). * * @see www.iso.org */ YE("YEM", 887), /** - * Zambia (a.k.a. the Republic of Zambia). + * Zambia (aka the Republic of Zambia). * * @see www.iso.org */ ZM("ZMB", 894), /** - * Zimbabwe (a.k.a. the Republic of Zimbabwe). + * Zimbabwe (aka the Republic of Zimbabwe). * * @see www.iso.org */ @@ -1914,6 +1926,12 @@ public boolean isParticipatingTo(Agreement agreement) { return agreement.getParticipants().contains(this); } + /** + * This country participations to {@link Agreement economic agreements}. + * + * @return a non-null set + * @since 2.1.0 + */ public Set participations() { Set agreements = EnumSet.noneOf(Agreement.class); diff --git a/src/main/java/fr/marcwrobel/jbanking/IsoCurrency.java b/src/main/java/fr/marcwrobel/jbanking/IsoCurrency.java index 8507da6..5728626 100644 --- a/src/main/java/fr/marcwrobel/jbanking/IsoCurrency.java +++ b/src/main/java/fr/marcwrobel/jbanking/IsoCurrency.java @@ -24,6 +24,19 @@ *
  • prevent accidental duplicates. * * + *

    + * Usage: + * + * 

    + * IsoCurrency currency = IsoCurrency.fromAlphabeticCode("EUR").get();
+ *
+ * Assertion.assertEquals(978, currency.getNumericCode());
+ * Assertion.assertEquals(2, currency.getMinorUnit().get());
+ * Assertion.assertEquals(NATIONAL, currency.getCategory());
+ * Assertion.assertTrue(currency.getCountries().contains(FR));
+ * Assertion.assertTrue(currency.isParticipatingTo(EUROPEAN_ECONOMIC_AREA));
+ *
    + * * @see currency-iso.org * @since 1.0 */ @@ -1503,6 +1516,9 @@ public static Set allOf(Category category) { return currencies; } + /** + * {@link IsoCurrency ISO 4217 currencies} categories. + */ public enum Category { /** diff --git a/src/main/java/fr/marcwrobel/jbanking/bic/Bic.java b/src/main/java/fr/marcwrobel/jbanking/bic/Bic.java index 5a32ecf..616b332 100644 --- a/src/main/java/fr/marcwrobel/jbanking/bic/Bic.java +++ b/src/main/java/fr/marcwrobel/jbanking/bic/Bic.java @@ -17,12 +17,30 @@ *
  • 2 letters or digits: location code *
  • 3 letters or digits (optional): branch code * + * *

    * Where an 8-digit code is given, it is assumed that it refers to the primary office. The primary office is always designated * by the branch code {@value #PRIMARY_OFFICE_BRANCH_CODE}). * *

    - * This class is immutable. + * Instances of this class are immutable and thread-safe. + * + *

    + * Usage: + * + * 

    + * // Validate a BIC
+ * Assertions.assertTrue(Bic.isValid("PSSTFRPPXXX"));
+ *
+ * // Retrieve BIC information
+ * Bic bic = new Bic("psstfrppxxx");
+ * Assertions.assertEquals("PSSTFRPPXXX", bic.toString());
+ * Assertions.assertEquals("PSST", bic.getInstitutionCode());
+ * Assertions.assertEquals("FR", bic.getCountryCode());
+ * Assertions.assertEquals("PP", bic.getLocationCode());
+ * Assertions.assertEquals("XXX", bic.getBranchCode());
+ * Assertions.assertTrue(bic.isLiveBic());
+ *
    * * @see http://wikipedia.org/wiki/Bank_Identifier_Code * @since 1.0 @@ -64,6 +82,9 @@ public final class Bic implements Serializable { private static final int BRANCH_CODE_INDEX = LOCATION_CODE_INDEX + LOCATION_CODE_LENGTH; private static final int BRANCH_CODE_LENGTH = 3; + /** + * The normalized form of this BIC. + */ private final String normalizedBic; /** diff --git a/src/main/java/fr/marcwrobel/jbanking/bic/BicFormatException.java b/src/main/java/fr/marcwrobel/jbanking/bic/BicFormatException.java index c85bd11..c9a52fb 100644 --- a/src/main/java/fr/marcwrobel/jbanking/bic/BicFormatException.java +++ b/src/main/java/fr/marcwrobel/jbanking/bic/BicFormatException.java @@ -9,9 +9,14 @@ */ public final class BicFormatException extends RuntimeException { - /** Serialization version. */ + /** + * Serialization version. + */ private static final long serialVersionUID = 0; + /** + * The string that caused the error. + */ private final String inputString; /** diff --git a/src/main/java/fr/marcwrobel/jbanking/bic/package-info.java b/src/main/java/fr/marcwrobel/jbanking/bic/package-info.java new file mode 100644 index 0000000..c28fd05 --- /dev/null +++ b/src/main/java/fr/marcwrobel/jbanking/bic/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes that relates to {@link fr.marcwrobel.jbanking.bic.Bic ISO 9362:2009 BICs} handling and validation. + */ +package fr.marcwrobel.jbanking.bic; diff --git a/src/main/java/fr/marcwrobel/jbanking/calendar/BridgedHoliday.java b/src/main/java/fr/marcwrobel/jbanking/calendar/BridgedHoliday.java index de6f094..d9c9dd5 100644 --- a/src/main/java/fr/marcwrobel/jbanking/calendar/BridgedHoliday.java +++ b/src/main/java/fr/marcwrobel/jbanking/calendar/BridgedHoliday.java @@ -17,6 +17,13 @@ public class BridgedHoliday implements Holiday { private final Holiday first; private final Holiday second; + /** + * Create a new holiday using the given first and second holidays. + * + * @param first the first non-null holiday + * @param second the second non-null holiday + * @throws NullPointerException if one of the given holidays is {@code null} + */ public BridgedHoliday(Holiday first, Holiday second) { this.first = requireNonNull(first); this.second = requireNonNull(second); diff --git a/src/main/java/fr/marcwrobel/jbanking/calendar/Calendar.java b/src/main/java/fr/marcwrobel/jbanking/calendar/Calendar.java index a069f29..bf11cd0 100644 --- a/src/main/java/fr/marcwrobel/jbanking/calendar/Calendar.java +++ b/src/main/java/fr/marcwrobel/jbanking/calendar/Calendar.java @@ -11,9 +11,41 @@ * called business days. * *

    - * Subclasses of this interface are expected to be thread-safe and immutable. + * Subclasses of this interface are expected to be immutable and thread-safe. + * + *

    + * Predefined calendars are available in {@link FinancialCalendars}. + * + *

    + * Usage : + * + * 

    + * // Build a new calendar
+ * Calendar calendar = new ConfigurableCalendar(
+ *     SATURDAY, SUNDAY, NEW_YEAR_DAY,
+ *     new MonthDayHoliday(JULY, 14),
+ *     new RelativeHoliday(WesternEaster.INSTANCE, 1) // easter monday
+ * );
+ *
+ * // Check holidays
+ * Assertion.assertTrue(calendar.isHoliday(LocalDate.of(2022, 1, 1))); // Saturday and New Year's Day
+ * Assertion.assertTrue(calendar.isHoliday(LocalDate.of(2022, 1, 2))); // Sunday
+ * Assertion.assertTrue(calendar.isHoliday(LocalDate.of(2022, 7, 14))); // Bastille day in France
+ *
+ * // Not an holiday
+ * Assertion.assertFalse(calendar.isHoliday(LocalDate.of(2022, 1, 11)));
+ * Assertion.assertTrue(calendar.isBusinessDay(LocalDate.of(2022, 1, 11)));
+ *
+ * // Get business days
+ * Assertion.assertEquals(LocalDate.of(2022, 1, 3), calendar.next(LocalDate.of(2022, 1, 1)));
+ * Assertion.assertEquals(
+ *     Arrays.asList(LocalDate.of(2022, 1, 3), LocalDate.of(2022, 1, 4)),
+ *     calendar.businessDaysWithin(LocalDate.of(2022, 1, 1), LocalDate.of(2022, 1, 4)));
+ *
    * * @since 2.1.0 + * @see Holidays + * @see FinancialCalendars */ public interface Calendar { diff --git a/src/main/java/fr/marcwrobel/jbanking/calendar/Holiday.java b/src/main/java/fr/marcwrobel/jbanking/calendar/Holiday.java index a237e57..700b06d 100644 --- a/src/main/java/fr/marcwrobel/jbanking/calendar/Holiday.java +++ b/src/main/java/fr/marcwrobel/jbanking/calendar/Holiday.java @@ -4,12 +4,16 @@ /** * Bank holidays are holidays when banks, and many other businesses, are closed for the day. This interface is representing a - * public holiday. + * public holiday. * *

    - * Subclasses of this interface are expected to be thread-safe and immutable. + * Subclasses of this interface are expected to be immutable and thread-safe. + * + *

    + * Predefined holidays are available in {@link Holidays}. * * @since 2.1.0 + * @see Holidays */ public interface Holiday { diff --git a/src/main/java/fr/marcwrobel/jbanking/calendar/WesternEaster.java b/src/main/java/fr/marcwrobel/jbanking/calendar/WesternEaster.java index 91ff2f9..e905729 100644 --- a/src/main/java/fr/marcwrobel/jbanking/calendar/WesternEaster.java +++ b/src/main/java/fr/marcwrobel/jbanking/calendar/WesternEaster.java @@ -13,6 +13,9 @@ * @since 2.1.0 */ public enum WesternEaster implements Holiday { + /** + * The singleton instance for this class. + */ INSTANCE; /** diff --git a/src/main/java/fr/marcwrobel/jbanking/calendar/package-info.java b/src/main/java/fr/marcwrobel/jbanking/calendar/package-info.java new file mode 100644 index 0000000..e1019d4 --- /dev/null +++ b/src/main/java/fr/marcwrobel/jbanking/calendar/package-info.java @@ -0,0 +1,6 @@ +/** + * Classes that relates to {@link fr.marcwrobel.jbanking.calendar.Holiday holidays} and + * {@link fr.marcwrobel.jbanking.calendar.Calendar calendars}, with some + * {@link fr.marcwrobel.jbanking.calendar.FinancialCalendars predefined financial calendars}. + */ +package fr.marcwrobel.jbanking.calendar; diff --git a/src/main/java/fr/marcwrobel/jbanking/creditor/CreditorIdentifier.java b/src/main/java/fr/marcwrobel/jbanking/creditor/CreditorIdentifier.java index 97bcf7d..adebd7b 100644 --- a/src/main/java/fr/marcwrobel/jbanking/creditor/CreditorIdentifier.java +++ b/src/main/java/fr/marcwrobel/jbanking/creditor/CreditorIdentifier.java @@ -7,7 +7,7 @@ import java.util.regex.Pattern; /** - * A Creditor Identifier (CI) Code as specified by the + * A Creditor Identifier (CI) code as specified by the * EPC. * *

    @@ -26,7 +26,23 @@ * going into the validation of the national identifier. * *

    - * Instances of this class are immutable and are safe for use by multiple concurrent threads. + * Instances of this class are immutable and thread-safe. + * + *

    + * Usage: + * + * 

    + * // Validate a creditor identifier
+ * Assertions.assertTrue(CreditorIdentifier.isValid("FR72ZZZ123456"));
+ *
+ * // Retrieve creditor identifier information
+ * CreditorIdentifier ci = new CreditorIdentifier("fr72zzz123456");
+ * Assertions.assertEquals("FR72ZZZ123456", ci.toString());
+ * Assertions.assertEquals("FR", ci.getCountryCode());
+ * Assertions.assertEquals("72", ci.getCheckDigit());
+ * Assertions.assertEquals("ZZZ", ci.getBusinessCode());
+ * Assertions.assertEquals("123456", ci.getNationalIdentifier());
+ *
    * * @see EPC * Creditor Identifier Overview @@ -49,6 +65,9 @@ public class CreditorIdentifier implements Serializable { private static final int CREDITOR_BUSINESS_CODE_LENGTH = 3; private static final int CREDITOR_NATIONAL_ID_INDEX = CREDITOR_BUSINESS_CODE_INDEX + CREDITOR_BUSINESS_CODE_LENGTH; + /** + * The normalized form of this Creditor Identifier. + */ private final String creditorId; /** diff --git a/src/main/java/fr/marcwrobel/jbanking/creditor/CreditorIdentifierFormatException.java b/src/main/java/fr/marcwrobel/jbanking/creditor/CreditorIdentifierFormatException.java index 6366b5a..9dbce1e 100644 --- a/src/main/java/fr/marcwrobel/jbanking/creditor/CreditorIdentifierFormatException.java +++ b/src/main/java/fr/marcwrobel/jbanking/creditor/CreditorIdentifierFormatException.java @@ -13,6 +13,9 @@ public class CreditorIdentifierFormatException extends RuntimeException { */ private static final long serialVersionUID = 0; + /** + * The string that caused the error. + */ private final String inputString; /** diff --git a/src/main/java/fr/marcwrobel/jbanking/creditor/package-info.java b/src/main/java/fr/marcwrobel/jbanking/creditor/package-info.java new file mode 100644 index 0000000..efcfc58 --- /dev/null +++ b/src/main/java/fr/marcwrobel/jbanking/creditor/package-info.java @@ -0,0 +1,5 @@ +/** + * Classes that relates to {@link fr.marcwrobel.jbanking.creditor.CreditorIdentifier Creditor Identifiers} handling and + * validation. + */ +package fr.marcwrobel.jbanking.creditor; diff --git a/src/main/java/fr/marcwrobel/jbanking/iban/Iban.java b/src/main/java/fr/marcwrobel/jbanking/iban/Iban.java index 57e3eea..e379088 100644 --- a/src/main/java/fr/marcwrobel/jbanking/iban/Iban.java +++ b/src/main/java/fr/marcwrobel/jbanking/iban/Iban.java @@ -19,7 +19,23 @@ * This class handles validation of the check digit and validation of the {@link BbanStructure BBAN structure}. * *

    - * Instances of this class are immutable and are safe for use by multiple concurrent threads. + * Instances of this class are immutable and thread-safe. + * + *

    + * Usage: + * + * 

    + * // Validate an IBAN
+ * Assertions.assertTrue(Iban.isValid("FR2531682128768051490609537"));
+ *
+ * // Retrieve IBAN information
+ * Iban iban = new Iban("fr2531682128768051490609537");
+ * Assertions.assertEquals("FR2531682128768051490609537", iban.toString());
+ * Assertions.assertEquals("FR", iban.getCountryCode());
+ * Assertions.assertEquals("25", iban.getCheckDigit());
+ * Assertions.assertEquals("31682128768051490609537", iban.getBban());
+ * Assertions.assertEquals("FR25 3168 2128 7680 5149 0609 537", iban.toPrintableString());
+ *
    * * @see BbanStructure * @see + *
  • + * {@link fr.marcwrobel.jbanking.IsoCountry} (with alpha-2 code, alpha-3 code, numeric code and status, e.g. + * independent or dependent according to the International Organization for + * Standardization).
    • + *
  • + * Countries or territories participation to various {@link fr.marcwrobel.jbanking.Agreement economic agreements}. + *
    • + *
  • + * {@link fr.marcwrobel.jbanking.IsoCurrency ISO 4217 currencies} (with alphabetic code, numeric code, minor unit + * and countries using it).
    • + * + */ +package fr.marcwrobel.jbanking; diff --git a/src/main/java/fr/marcwrobel/jbanking/swift/SwiftPattern.java b/src/main/java/fr/marcwrobel/jbanking/swift/SwiftPattern.java index 6f5b831..5bc6819 100644 --- a/src/main/java/fr/marcwrobel/jbanking/swift/SwiftPattern.java +++ b/src/main/java/fr/marcwrobel/jbanking/swift/SwiftPattern.java @@ -51,11 +51,11 @@ * Here are some examples of SWIFT expressions that are supported by this SwiftPattern :
    * *
      - *
    • {@code 4!n} (corresponding regex [0-9]{4}) : four consecutive digits - *
    • {@code 4!a3c} (corresponding regex [A-Za-z0-9]{4}[A-Z]{1,3}) : four consecutive upper or lower case alphanumeric + *
    • {@code 4!n} (corresponding regex {@code [0-9]{4}}) : four consecutive digits + *
    • {@code 4!c3a} (corresponding regex {@code [A-Za-z0-9]{4}[A-Z]{1,3}}) : four consecutive upper or lower case alphanumeric * characters followed by one to three upper case letters - *
    • {@code 2e4!a} (corresponding regex [ ]{1,2}) : one or two consecutive spaces followed by four consecutive upper - * case letters + *
    • {@code 2e4!a} (corresponding regex {@code [ ]{1,2}[A-Z]{4}}) : one or two consecutive spaces followed by four consecutive + * upper case letters *
    * *

    @@ -65,7 +65,7 @@ * {@code 4!n}) is 1000. these limitations are far above anything that can be seen in SWIFT documents and should be sufficient. * *

    - * Instances of this class are immutable and are safe for use by multiple concurrent threads. + * Instances of this class are immutable and thread-safe. * * @see java.util.regex.Pattern * @since 1.0 @@ -91,7 +91,14 @@ public final class SwiftPattern implements Serializable { private static final Pattern SWIFT_FORMAT_PATTERN = Pattern.compile("^(" + GROUP_REGEX + "){1,1000}$"); private static final Pattern SWIFT_FORMAT_GROUPS_PATTERN = Pattern.compile(GROUP_REGEX); + /** + * The SWIFT pattern. + */ private final String expression; + + /** + * The Java pattern constructed from the SWIFT pattern. + */ private final Pattern equivalentJavaPattern; private SwiftPattern(String expression, Pattern equivalentJavaPattern) { diff --git a/src/main/java/fr/marcwrobel/jbanking/swift/SwiftPatternSyntaxException.java b/src/main/java/fr/marcwrobel/jbanking/swift/SwiftPatternSyntaxException.java index c21710e..6729191 100644 --- a/src/main/java/fr/marcwrobel/jbanking/swift/SwiftPatternSyntaxException.java +++ b/src/main/java/fr/marcwrobel/jbanking/swift/SwiftPatternSyntaxException.java @@ -13,6 +13,9 @@ public class SwiftPatternSyntaxException extends RuntimeException { */ private static final long serialVersionUID = 0; + /** + * The string that caused the error. + */ private final String expression; /** diff --git a/src/main/java/fr/marcwrobel/jbanking/swift/package-info.java b/src/main/java/fr/marcwrobel/jbanking/swift/package-info.java new file mode 100644 index 0000000..0e91ba4 --- /dev/null +++ b/src/main/java/fr/marcwrobel/jbanking/swift/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes that relates to SWIFT concepts, such as {@link fr.marcwrobel.jbanking.swift.SwiftPattern SWIFT patterns}. + */ +package fr.marcwrobel.jbanking.swift; diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html new file mode 100644 index 0000000..643faec --- /dev/null +++ b/src/main/javadoc/overview.html @@ -0,0 +1,67 @@ + + + + API Overview + + +

    + jbanking is a library of utilities to assist with developing banking functionalities. jbanking is focused on, but not + limited to, European banking. +

    +

    + jbanking is supporting the following features : +

    + + +