From dc843995a2180927f907e42f03e754344d46cbf8 Mon Sep 17 00:00:00 2001 From: xiangying Date: Wed, 11 Jun 2025 20:09:56 +0800 Subject: [PATCH 1/4] Fix documentation terminology: Correct "Enumerator" to "Enumeration" ### Motivation The current documentation incorrectly uses "Enumerator" when referring to the Java standard interface `java.util.Enumeration`. "Enumerator" is not a valid Java term, leading to confusion and inaccuracies. **Impact** 1. Misleads developers searching for non-existent `Enumerator` APIs 2. Creates inconsistency with Java official documentation 3. May cause misunderstandings about legacy Java collection frameworks ### Modification - Replaced all `Enumerator` references with `Enumeration` --- site3/website/docs/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.10.0/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.11.1/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.12.1/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.13.0/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.14.8/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.15.5/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.16.6/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.17.1/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.5.1/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.6.2/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.7.3/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.8.2/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.9.2/api/ledger-api.md | 6 +++--- 14 files changed, 42 insertions(+), 42 deletions(-) diff --git a/site3/website/docs/api/ledger-api.md b/site3/website/docs/api/ledger-api.md index 54ef7793b04..ec8f8e5e6a8 100644 --- a/site3/website/docs/api/ledger-api.md +++ b/site3/website/docs/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.10.0/api/ledger-api.md b/site3/website/versioned_docs/version-4.10.0/api/ledger-api.md index 5122a7472c8..d7ffa9e8319 100644 --- a/site3/website/versioned_docs/version-4.10.0/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.10.0/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.11.1/api/ledger-api.md b/site3/website/versioned_docs/version-4.11.1/api/ledger-api.md index 6ea20c8bde9..a77c7c39647 100644 --- a/site3/website/versioned_docs/version-4.11.1/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.11.1/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.12.1/api/ledger-api.md b/site3/website/versioned_docs/version-4.12.1/api/ledger-api.md index 8e6bb190581..73f041f034e 100644 --- a/site3/website/versioned_docs/version-4.12.1/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.12.1/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.13.0/api/ledger-api.md b/site3/website/versioned_docs/version-4.13.0/api/ledger-api.md index f9c83096857..6d2f3aefbe8 100644 --- a/site3/website/versioned_docs/version-4.13.0/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.13.0/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.14.8/api/ledger-api.md b/site3/website/versioned_docs/version-4.14.8/api/ledger-api.md index df4676c1080..9065d6d4e34 100644 --- a/site3/website/versioned_docs/version-4.14.8/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.14.8/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.15.5/api/ledger-api.md b/site3/website/versioned_docs/version-4.15.5/api/ledger-api.md index eab48c9687c..6c3c1efd74d 100644 --- a/site3/website/versioned_docs/version-4.15.5/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.15.5/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.16.6/api/ledger-api.md b/site3/website/versioned_docs/version-4.16.6/api/ledger-api.md index cac3901e25c..f79de7d1b83 100644 --- a/site3/website/versioned_docs/version-4.16.6/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.16.6/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.17.1/api/ledger-api.md b/site3/website/versioned_docs/version-4.17.1/api/ledger-api.md index 00c22f8c010..f810599aad6 100644 --- a/site3/website/versioned_docs/version-4.17.1/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.17.1/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.5.1/api/ledger-api.md b/site3/website/versioned_docs/version-4.5.1/api/ledger-api.md index 84a51db36d8..9a81edae741 100644 --- a/site3/website/versioned_docs/version-4.5.1/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.5.1/api/ledger-api.md @@ -138,13 +138,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -162,7 +162,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.6.2/api/ledger-api.md b/site3/website/versioned_docs/version-4.6.2/api/ledger-api.md index 01469acdb99..6a16310d403 100644 --- a/site3/website/versioned_docs/version-4.6.2/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.6.2/api/ledger-api.md @@ -201,13 +201,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -225,7 +225,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.7.3/api/ledger-api.md b/site3/website/versioned_docs/version-4.7.3/api/ledger-api.md index a4c12e7f21d..a34b87cb6c5 100644 --- a/site3/website/versioned_docs/version-4.7.3/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.7.3/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.8.2/api/ledger-api.md b/site3/website/versioned_docs/version-4.8.2/api/ledger-api.md index f36767d42da..799845986c8 100644 --- a/site3/website/versioned_docs/version-4.8.2/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.8.2/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.9.2/api/ledger-api.md b/site3/website/versioned_docs/version-4.9.2/api/ledger-api.md index 7e6b5f0e431..75ec088c25d 100644 --- a/site3/website/versioned_docs/version-4.9.2/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.9.2/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumerator entries = +Enumeration entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { From fd7d04fac80c04a386ec0cdfdcaf6a1dbaecaa69 Mon Sep 17 00:00:00 2001 From: xiangying Date: Wed, 11 Jun 2025 20:51:30 +0800 Subject: [PATCH 2/4] refactor --- site3/website/docs/api/ledger-api.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/site3/website/docs/api/ledger-api.md b/site3/website/docs/api/ledger-api.md index ec8f8e5e6a8..6a74a2d2e8e 100644 --- a/site3/website/docs/api/ledger-api.md +++ b/site3/website/docs/api/ledger-api.md @@ -188,12 +188,12 @@ With this method you can even read entries before the LastAddConfirmed and entri ```java Enumeration entries = - handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); + handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); -while (entries.hasNextElement()) { - LedgerEntry entry = entries.nextElement(); - System.out.println("Successfully read entry " + entry.getId()); -} +while (entries.hasMoreElements()) { +LedgerEntry entry = entries.nextElement(); + System.out.println("Successfully read entry " + entry.getEntryId()); + } ``` ## Deleting ledgers @@ -216,9 +216,10 @@ Ledgers can also be deleted asynchronously: ```java class DeleteEntryCallback implements AsyncCallback.DeleteCallback { - public void deleteComplete() { - System.out.println("Delete completed"); - } + @Override + public void deleteComplete(int rc, Object ctx) { + System.out.println("Delete completed"); + } } bkClient.asyncDeleteLedger(ledgerID, new DeleteEntryCallback(), null); ``` From 6b529841db8d9334b1e1b2abb733050b4fc9a1f6 Mon Sep 17 00:00:00 2001 From: xiangying Date: Wed, 11 Jun 2025 20:52:48 +0800 Subject: [PATCH 3/4] Revert "Fix documentation terminology: Correct "Enumerator" to "Enumeration"" This reverts commit dc843995 --- site3/website/docs/api/ledger-api.md | 4 ++-- .../website/versioned_docs/version-4.10.0/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.11.1/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.12.1/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.13.0/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.14.8/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.15.5/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.16.6/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.17.1/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.5.1/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.6.2/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.7.3/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.8.2/api/ledger-api.md | 6 +++--- .../website/versioned_docs/version-4.9.2/api/ledger-api.md | 6 +++--- 14 files changed, 41 insertions(+), 41 deletions(-) diff --git a/site3/website/docs/api/ledger-api.md b/site3/website/docs/api/ledger-api.md index 6a74a2d2e8e..ca3fa6fdee6 100644 --- a/site3/website/docs/api/ledger-api.md +++ b/site3/website/docs/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.10.0/api/ledger-api.md b/site3/website/versioned_docs/version-4.10.0/api/ledger-api.md index d7ffa9e8319..5122a7472c8 100644 --- a/site3/website/versioned_docs/version-4.10.0/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.10.0/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.11.1/api/ledger-api.md b/site3/website/versioned_docs/version-4.11.1/api/ledger-api.md index a77c7c39647..6ea20c8bde9 100644 --- a/site3/website/versioned_docs/version-4.11.1/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.11.1/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.12.1/api/ledger-api.md b/site3/website/versioned_docs/version-4.12.1/api/ledger-api.md index 73f041f034e..8e6bb190581 100644 --- a/site3/website/versioned_docs/version-4.12.1/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.12.1/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.13.0/api/ledger-api.md b/site3/website/versioned_docs/version-4.13.0/api/ledger-api.md index 6d2f3aefbe8..f9c83096857 100644 --- a/site3/website/versioned_docs/version-4.13.0/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.13.0/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.14.8/api/ledger-api.md b/site3/website/versioned_docs/version-4.14.8/api/ledger-api.md index 9065d6d4e34..df4676c1080 100644 --- a/site3/website/versioned_docs/version-4.14.8/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.14.8/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.15.5/api/ledger-api.md b/site3/website/versioned_docs/version-4.15.5/api/ledger-api.md index 6c3c1efd74d..eab48c9687c 100644 --- a/site3/website/versioned_docs/version-4.15.5/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.15.5/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.16.6/api/ledger-api.md b/site3/website/versioned_docs/version-4.16.6/api/ledger-api.md index f79de7d1b83..cac3901e25c 100644 --- a/site3/website/versioned_docs/version-4.16.6/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.16.6/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.17.1/api/ledger-api.md b/site3/website/versioned_docs/version-4.17.1/api/ledger-api.md index f810599aad6..00c22f8c010 100644 --- a/site3/website/versioned_docs/version-4.17.1/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.17.1/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.5.1/api/ledger-api.md b/site3/website/versioned_docs/version-4.5.1/api/ledger-api.md index 9a81edae741..84a51db36d8 100644 --- a/site3/website/versioned_docs/version-4.5.1/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.5.1/api/ledger-api.md @@ -138,13 +138,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -162,7 +162,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.6.2/api/ledger-api.md b/site3/website/versioned_docs/version-4.6.2/api/ledger-api.md index 6a16310d403..01469acdb99 100644 --- a/site3/website/versioned_docs/version-4.6.2/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.6.2/api/ledger-api.md @@ -201,13 +201,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -225,7 +225,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.7.3/api/ledger-api.md b/site3/website/versioned_docs/version-4.7.3/api/ledger-api.md index a34b87cb6c5..a4c12e7f21d 100644 --- a/site3/website/versioned_docs/version-4.7.3/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.7.3/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.8.2/api/ledger-api.md b/site3/website/versioned_docs/version-4.8.2/api/ledger-api.md index 799845986c8..f36767d42da 100644 --- a/site3/website/versioned_docs/version-4.8.2/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.8.2/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { diff --git a/site3/website/versioned_docs/version-4.9.2/api/ledger-api.md b/site3/website/versioned_docs/version-4.9.2/api/ledger-api.md index 75ec088c25d..7e6b5f0e431 100644 --- a/site3/website/versioned_docs/version-4.9.2/api/ledger-api.md +++ b/site3/website/versioned_docs/version-4.9.2/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumeration entries = handle.readEntries(1, 99); +Enumerator entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumeration entries = +Enumerator entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -187,7 +187,7 @@ For entries outside that range it is possible that the writer never received the With this method you can even read entries before the LastAddConfirmed and entries after it with one call, the expected consistency will be as described above. ```java -Enumeration entries = +Enumerator entries = handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasNextElement()) { From 44ecdefffb759b0c7ec082fd5cae83c9763ec648 Mon Sep 17 00:00:00 2001 From: xiangying Date: Wed, 11 Jun 2025 20:53:38 +0800 Subject: [PATCH 4/4] Fix documentation terminology: Correct "Enumerator" to "Enumeration" ### Motivation The current documentation incorrectly uses "Enumerator" when referring to the Java standard interface `java.util.Enumeration`. "Enumerator" is not a valid Java term, leading to confusion and inaccuracies. **Impact** 1. Misleads developers searching for non-existent `Enumerator` APIs 2. Creates inconsistency with Java official documentation 3. May cause misunderstandings about legacy Java collection frameworks ### Modification - Replaced all `Enumerator` references with `Enumeration` --- site3/website/docs/api/ledger-api.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/site3/website/docs/api/ledger-api.md b/site3/website/docs/api/ledger-api.md index ca3fa6fdee6..541dd01ed48 100644 --- a/site3/website/docs/api/ledger-api.md +++ b/site3/website/docs/api/ledger-api.md @@ -163,13 +163,13 @@ long entryId = ledger.addEntry("Some entry data".getBytes()); ## Reading entries from ledgers ```java -Enumerator entries = handle.readEntries(1, 99); +Enumeration entries = handle.readEntries(1, 99); ``` To read all possible entries from the ledger: ```java -Enumerator entries = +Enumeration entries = handle.readEntries(0, handle.getLastAddConfirmed()); while (entries.hasNextElement()) { @@ -188,12 +188,12 @@ With this method you can even read entries before the LastAddConfirmed and entri ```java Enumeration entries = - handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); + handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead); while (entries.hasMoreElements()) { -LedgerEntry entry = entries.nextElement(); + LedgerEntry entry = entries.nextElement(); System.out.println("Successfully read entry " + entry.getEntryId()); - } +} ``` ## Deleting ledgers @@ -216,10 +216,10 @@ Ledgers can also be deleted asynchronously: ```java class DeleteEntryCallback implements AsyncCallback.DeleteCallback { - @Override - public void deleteComplete(int rc, Object ctx) { - System.out.println("Delete completed"); - } + @Override + public void deleteComplete(int rc, Object ctx) { + System.out.println("Delete completed"); + } } bkClient.asyncDeleteLedger(ledgerID, new DeleteEntryCallback(), null); ```