From b25899de58c833d21357924c5cfa8f83b079f855 Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Thu, 18 Dec 2014 13:37:05 +0100 Subject: [PATCH] Rename DownloadListener to DownloadProgressTracker --- .../{DownloadListener.java => DownloadProgressTracker.java} | 6 ++---- core/src/main/java/org/bitcoinj/core/PeerGroup.java | 5 ++--- core/src/main/java/org/bitcoinj/kits/WalletAppKit.java | 6 +++--- .../main/java/org/bitcoinj/examples/RestoreFromSeed.java | 2 +- tools/src/main/java/org/bitcoinj/tools/WalletTool.java | 2 +- .../src/main/java/wallettemplate/MainController.java | 6 +++--- .../src/main/java/wallettemplate/utils/BitcoinUIModel.java | 4 ++-- 7 files changed, 14 insertions(+), 17 deletions(-) rename core/src/main/java/org/bitcoinj/core/{DownloadListener.java => DownloadProgressTracker.java} (95%) diff --git a/core/src/main/java/org/bitcoinj/core/DownloadListener.java b/core/src/main/java/org/bitcoinj/core/DownloadProgressTracker.java similarity index 95% rename from core/src/main/java/org/bitcoinj/core/DownloadListener.java rename to core/src/main/java/org/bitcoinj/core/DownloadProgressTracker.java index 4100ccc9..920dda0c 100644 --- a/core/src/main/java/org/bitcoinj/core/DownloadListener.java +++ b/core/src/main/java/org/bitcoinj/core/DownloadProgressTracker.java @@ -23,15 +23,13 @@ import org.slf4j.LoggerFactory; import java.util.Date; import java.util.concurrent.Semaphore; -// TODO: Rename this to DownloadProgressTracker or something more appropriate. - /** *

An implementation of {@link AbstractPeerEventListener} that listens to chain download events and tracks progress * as a percentage. The default implementation prints progress to stdout, but you can subclass it and override the * progress method to update a GUI instead.

*/ -public class DownloadListener extends AbstractPeerEventListener { - private static final Logger log = LoggerFactory.getLogger(DownloadListener.class); +public class DownloadProgressTracker extends AbstractPeerEventListener { + private static final Logger log = LoggerFactory.getLogger(DownloadProgressTracker.class); private int originalBlocksLeft = -1; private int lastPercent = 0; private Semaphore done = new Semaphore(0); diff --git a/core/src/main/java/org/bitcoinj/core/PeerGroup.java b/core/src/main/java/org/bitcoinj/core/PeerGroup.java index 16651076..ba898048 100644 --- a/core/src/main/java/org/bitcoinj/core/PeerGroup.java +++ b/core/src/main/java/org/bitcoinj/core/PeerGroup.java @@ -18,7 +18,6 @@ package org.bitcoinj.core; import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.Preconditions; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Lists; @@ -1221,13 +1220,13 @@ public class PeerGroup implements TransactionBroadcaster { } /** - * Download the blockchain from peers. Convenience that uses a {@link DownloadListener} for you.

+ * Download the blockchain from peers. Convenience that uses a {@link DownloadProgressTracker} for you.

* * This method waits until the download is complete. "Complete" is defined as downloading * from at least one peer all the blocks that are in that peer's inventory. */ public void downloadBlockChain() { - DownloadListener listener = new DownloadListener(); + DownloadProgressTracker listener = new DownloadProgressTracker(); startBlockChainDownload(listener); try { listener.await(); diff --git a/core/src/main/java/org/bitcoinj/kits/WalletAppKit.java b/core/src/main/java/org/bitcoinj/kits/WalletAppKit.java index 66619c06..bd80508a 100644 --- a/core/src/main/java/org/bitcoinj/kits/WalletAppKit.java +++ b/core/src/main/java/org/bitcoinj/kits/WalletAppKit.java @@ -129,7 +129,7 @@ public class WalletAppKit extends AbstractIdleService { /** * If you want to learn about the sync process, you can provide a listener here. For instance, a - * {@link DownloadListener} is a good choice. This has no effect unless setBlockingStartup(false) has been called + * {@link org.bitcoinj.core.DownloadProgressTracker} is a good choice. This has no effect unless setBlockingStartup(false) has been called * too, due to some missing implementation code. */ public WalletAppKit setDownloadListener(PeerEventListener listener) { @@ -305,7 +305,7 @@ public class WalletAppKit extends AbstractIdleService { completeExtensionInitiations(vPeerGroup); // TODO: Be able to use the provided download listener when doing a blocking startup. - final DownloadListener listener = new DownloadListener(); + final DownloadProgressTracker listener = new DownloadProgressTracker(); vPeerGroup.startBlockChainDownload(listener); listener.await(); } else { @@ -313,7 +313,7 @@ public class WalletAppKit extends AbstractIdleService { @Override public void onSuccess(@Nullable Object result) { completeExtensionInitiations(vPeerGroup); - final PeerEventListener l = downloadListener == null ? new DownloadListener() : downloadListener; + final PeerEventListener l = downloadListener == null ? new DownloadProgressTracker() : downloadListener; vPeerGroup.startBlockChainDownload(l); } diff --git a/examples/src/main/java/org/bitcoinj/examples/RestoreFromSeed.java b/examples/src/main/java/org/bitcoinj/examples/RestoreFromSeed.java index 1b6d07dd..39b52b5e 100644 --- a/examples/src/main/java/org/bitcoinj/examples/RestoreFromSeed.java +++ b/examples/src/main/java/org/bitcoinj/examples/RestoreFromSeed.java @@ -50,7 +50,7 @@ public class RestoreFromSeed { chain.addWallet(wallet); peers.addWallet(wallet); - DownloadListener bListener = new DownloadListener() { + DownloadProgressTracker bListener = new DownloadProgressTracker() { @Override public void doneDownload() { System.out.println("blockchain downloaded"); diff --git a/tools/src/main/java/org/bitcoinj/tools/WalletTool.java b/tools/src/main/java/org/bitcoinj/tools/WalletTool.java index 1428376d..1e16abff 100644 --- a/tools/src/main/java/org/bitcoinj/tools/WalletTool.java +++ b/tools/src/main/java/org/bitcoinj/tools/WalletTool.java @@ -860,7 +860,7 @@ public class WalletTool { try { setup(); int startTransactions = wallet.getTransactions(true).size(); - DownloadListener listener = new DownloadListener(); + DownloadProgressTracker listener = new DownloadProgressTracker(); peers.start(); peers.startBlockChainDownload(listener); try { diff --git a/wallettemplate/src/main/java/wallettemplate/MainController.java b/wallettemplate/src/main/java/wallettemplate/MainController.java index 50a908ee..a4a4ca77 100644 --- a/wallettemplate/src/main/java/wallettemplate/MainController.java +++ b/wallettemplate/src/main/java/wallettemplate/MainController.java @@ -1,7 +1,7 @@ package wallettemplate; import org.bitcoinj.core.Coin; -import org.bitcoinj.core.DownloadListener; +import org.bitcoinj.core.DownloadProgressTracker; import org.bitcoinj.utils.MonetaryFormat; import com.subgraph.orchid.TorClient; import com.subgraph.orchid.TorInitializationListener; @@ -121,7 +121,7 @@ public class MainController { group.play(); } - public DownloadListener progressBarUpdater() { - return model.getDownloadListener(); + public DownloadProgressTracker progressBarUpdater() { + return model.getDownloadProgressTracker(); } } diff --git a/wallettemplate/src/main/java/wallettemplate/utils/BitcoinUIModel.java b/wallettemplate/src/main/java/wallettemplate/utils/BitcoinUIModel.java index 2145fe27..4c2df965 100644 --- a/wallettemplate/src/main/java/wallettemplate/utils/BitcoinUIModel.java +++ b/wallettemplate/src/main/java/wallettemplate/utils/BitcoinUIModel.java @@ -41,7 +41,7 @@ public class BitcoinUIModel { address.set(wallet.currentReceiveAddress()); } - private class ProgressBarUpdater extends DownloadListener { + private class ProgressBarUpdater extends DownloadProgressTracker { @Override protected void progress(double pct, int blocksLeft, Date date) { super.progress(pct, blocksLeft, date); @@ -55,7 +55,7 @@ public class BitcoinUIModel { } } - public DownloadListener getDownloadListener() { return syncProgressUpdater; } + public DownloadProgressTracker getDownloadProgressTracker() { return syncProgressUpdater; } public ReadOnlyDoubleProperty syncProgressProperty() { return syncProgress; }