From f693d886205d0ba4caba13a11b84ead46c91b1c9 Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Wed, 18 Mar 2015 12:49:13 +0100 Subject: [PATCH] Add JavaDocs for the new PeerGroup methods added by Oscar. --- core/src/main/java/org/bitcoinj/core/PeerGroup.java | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/core/src/main/java/org/bitcoinj/core/PeerGroup.java b/core/src/main/java/org/bitcoinj/core/PeerGroup.java index bc7f479d..436acf64 100644 --- a/core/src/main/java/org/bitcoinj/core/PeerGroup.java +++ b/core/src/main/java/org/bitcoinj/core/PeerGroup.java @@ -1912,11 +1912,17 @@ public class PeerGroup implements TransactionBroadcaster { public boolean isRunning() { return vRunning; } - + + /** + * Can be used to disable Bloom filtering entirely, even in SPV mode. You are very unlikely to need this, it is + * an optimisation for rare cases when full validation is not required but it's still more efficient to download + * full blocks than filtered blocks. + */ public void setBloomFilteringEnabled(boolean bloomFilteringEnabled) { this.vBloomFilteringEnabled = bloomFilteringEnabled; } - + + /** Returns whether the Bloom filtering protocol optimisation is in use: defaults to true. */ public boolean isBloomFilteringEnabled() { return vBloomFilteringEnabled; }