From fa63c83888efe4d395a21ed9293e13171a9863fd Mon Sep 17 00:00:00 2001 From: Andreas Schildbach Date: Fri, 30 May 2014 19:17:50 +0200 Subject: [PATCH] Fix 'java.math.Coin' in the JavaDocs. --- .../java/com/google/bitcoin/core/TransactionOutput.java | 4 ++-- core/src/main/java/com/google/bitcoin/core/Wallet.java | 6 +++--- .../bitcoin/protocols/channels/IPaymentChannelClient.java | 2 +- .../protocols/channels/PaymentChannelClientConnection.java | 2 +- .../protocols/channels/PaymentChannelClientState.java | 2 +- .../main/java/com/google/bitcoin/wallet/CoinSelection.java | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/core/src/main/java/com/google/bitcoin/core/TransactionOutput.java b/core/src/main/java/com/google/bitcoin/core/TransactionOutput.java index 86dc2e5b..463d2408 100644 --- a/core/src/main/java/com/google/bitcoin/core/TransactionOutput.java +++ b/core/src/main/java/com/google/bitcoin/core/TransactionOutput.java @@ -92,7 +92,7 @@ public class TransactionOutput extends ChildMessage implements Serializable { /** * Creates an output that sends 'value' to the given address (public key hash). The amount should be created with * something like {@link Utils#valueOf(int, int)}. Typically you would use - * {@link Transaction#addOutput(java.math.Coin, Address)} instead of creating a TransactionOutput directly. + * {@link Transaction#addOutput(Coin, Address)} instead of creating a TransactionOutput directly. */ public TransactionOutput(NetworkParameters params, @Nullable Transaction parent, Coin value, Address to) { this(params, parent, value, ScriptBuilder.createOutputScript(to).getProgram()); @@ -101,7 +101,7 @@ public class TransactionOutput extends ChildMessage implements Serializable { /** * Creates an output that sends 'value' to the given public key using a simple CHECKSIG script (no addresses). The * amount should be created with something like {@link Utils#valueOf(int, int)}. Typically you would use - * {@link Transaction#addOutput(java.math.Coin, ECKey)} instead of creating an output directly. + * {@link Transaction#addOutput(Coin, ECKey)} instead of creating an output directly. */ public TransactionOutput(NetworkParameters params, @Nullable Transaction parent, Coin value, ECKey to) { this(params, parent, value, ScriptBuilder.createOutputScript(to).getProgram()); diff --git a/core/src/main/java/com/google/bitcoin/core/Wallet.java b/core/src/main/java/com/google/bitcoin/core/Wallet.java index efe5447b..f9e0bfab 100644 --- a/core/src/main/java/com/google/bitcoin/core/Wallet.java +++ b/core/src/main/java/com/google/bitcoin/core/Wallet.java @@ -2141,7 +2141,7 @@ public class Wallet extends BaseTaggableObject implements Serializable, BlockCha * *

Be careful to check the output's value is reasonable using * {@link TransactionOutput#getMinNonDustValue(Coin)} afterwards or you risk having the transaction - * rejected by the network. Note that using {@link SendRequest#to(Address, java.math.Coin)} will result + * rejected by the network. Note that using {@link SendRequest#to(Address, Coin)} will result * in a smaller output, and thus the ability to use a smaller output value without rejection.

*/ public static SendRequest to(NetworkParameters params, ECKey destination, Coin value) { @@ -2174,11 +2174,11 @@ public class Wallet extends BaseTaggableObject implements Serializable, BlockCha * {@link Wallet#getChangeAddress()}, so you must have added at least one key.

* *

If you just want to send money quickly, you probably want - * {@link Wallet#sendCoins(TransactionBroadcaster, Address, java.math.Coin)} instead. That will create the sending + * {@link Wallet#sendCoins(TransactionBroadcaster, Address, Coin)} instead. That will create the sending * transaction, commit to the wallet and broadcast it to the network all in one go. This method is lower level * and lets you see the proposed transaction before anything is done with it.

* - *

This is a helper method that is equivalent to using {@link Wallet.SendRequest#to(Address, java.math.Coin)} + *

This is a helper method that is equivalent to using {@link Wallet.SendRequest#to(Address, Coin)} * followed by {@link Wallet#completeTx(Wallet.SendRequest)} and returning the requests transaction object. * Note that this means a fee may be automatically added if required, if you want more control over the process, * just do those two steps yourself.

diff --git a/core/src/main/java/com/google/bitcoin/protocols/channels/IPaymentChannelClient.java b/core/src/main/java/com/google/bitcoin/protocols/channels/IPaymentChannelClient.java index c3b026f4..052f4303 100644 --- a/core/src/main/java/com/google/bitcoin/protocols/channels/IPaymentChannelClient.java +++ b/core/src/main/java/com/google/bitcoin/protocols/channels/IPaymentChannelClient.java @@ -118,7 +118,7 @@ public interface IPaymentChannelClient { /** *

Indicates the channel has been successfully opened and - * {@link com.google.bitcoin.protocols.channels.PaymentChannelClient#incrementPayment(java.math.Coin)} + * {@link com.google.bitcoin.protocols.channels.PaymentChannelClient#incrementPayment(Coin)} * may be called at will.

* *

Called while holding a lock on the {@link com.google.bitcoin.protocols.channels.PaymentChannelClient} diff --git a/core/src/main/java/com/google/bitcoin/protocols/channels/PaymentChannelClientConnection.java b/core/src/main/java/com/google/bitcoin/protocols/channels/PaymentChannelClientConnection.java index 4017afc0..539a6b0d 100644 --- a/core/src/main/java/com/google/bitcoin/protocols/channels/PaymentChannelClientConnection.java +++ b/core/src/main/java/com/google/bitcoin/protocols/channels/PaymentChannelClientConnection.java @@ -120,7 +120,7 @@ public class PaymentChannelClientConnection { * an error before the channel has reached the open state.

* *

After this future completes successfully, you may call - * {@link PaymentChannelClientConnection#incrementPayment(java.math.Coin)} to begin paying the server.

+ * {@link PaymentChannelClientConnection#incrementPayment(Coin)} to begin paying the server.

*/ public ListenableFuture getChannelOpenFuture() { return channelOpenFuture; diff --git a/core/src/main/java/com/google/bitcoin/protocols/channels/PaymentChannelClientState.java b/core/src/main/java/com/google/bitcoin/protocols/channels/PaymentChannelClientState.java index 62ad1fa7..ba7885a7 100644 --- a/core/src/main/java/com/google/bitcoin/protocols/channels/PaymentChannelClientState.java +++ b/core/src/main/java/com/google/bitcoin/protocols/channels/PaymentChannelClientState.java @@ -291,7 +291,7 @@ public class PaymentChannelClientState { /** * Returns the transaction that locks the money to the agreement of both parties. Do not mutate the result. - * Once this step is done, you can use {@link PaymentChannelClientState#incrementPaymentBy(java.math.Coin)} to + * Once this step is done, you can use {@link PaymentChannelClientState#incrementPaymentBy(Coin)} to * start paying the server. */ public synchronized Transaction getMultisigContract() { diff --git a/core/src/main/java/com/google/bitcoin/wallet/CoinSelection.java b/core/src/main/java/com/google/bitcoin/wallet/CoinSelection.java index 67cf40e1..560176d4 100644 --- a/core/src/main/java/com/google/bitcoin/wallet/CoinSelection.java +++ b/core/src/main/java/com/google/bitcoin/wallet/CoinSelection.java @@ -7,7 +7,7 @@ import java.util.Collection; /** * Represents the results of a - * {@link com.google.bitcoin.wallet.CoinSelector#select(java.math.Coin, java.util.LinkedList)} operation. A + * {@link com.google.bitcoin.wallet.CoinSelector#select(Coin, java.util.LinkedList)} operation. A * coin selection represents a list of spendable transaction outputs that sum together to give valueGathered. * Different coin selections could be produced by different coin selectors from the same input set, according * to their varying policies.