3
0
mirror of https://github.com/Qortal/altcoinj.git synced 2025-02-07 23:03:04 +00:00

Fix 'java.math.Coin' in the JavaDocs.

This commit is contained in:
Andreas Schildbach 2014-05-30 19:17:50 +02:00
parent 346e8fb3bf
commit fa63c83888
6 changed files with 9 additions and 9 deletions

View File

@ -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 * 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 * 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) { public TransactionOutput(NetworkParameters params, @Nullable Transaction parent, Coin value, Address to) {
this(params, parent, value, ScriptBuilder.createOutputScript(to).getProgram()); 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 * 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 * 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) { public TransactionOutput(NetworkParameters params, @Nullable Transaction parent, Coin value, ECKey to) {
this(params, parent, value, ScriptBuilder.createOutputScript(to).getProgram()); this(params, parent, value, ScriptBuilder.createOutputScript(to).getProgram());

View File

@ -2141,7 +2141,7 @@ public class Wallet extends BaseTaggableObject implements Serializable, BlockCha
* *
* <p>Be careful to check the output's value is reasonable using * <p>Be careful to check the output's value is reasonable using
* {@link TransactionOutput#getMinNonDustValue(Coin)} afterwards or you risk having the transaction * {@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.</p> * in a smaller output, and thus the ability to use a smaller output value without rejection.</p>
*/ */
public static SendRequest to(NetworkParameters params, ECKey destination, Coin value) { 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.</p> * {@link Wallet#getChangeAddress()}, so you must have added at least one key.</p>
* *
* <p>If you just want to send money quickly, you probably want * <p>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 * 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.</p> * and lets you see the proposed transaction before anything is done with it.</p>
* *
* <p>This is a helper method that is equivalent to using {@link Wallet.SendRequest#to(Address, java.math.Coin)} * <p>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. * 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, * 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.</p> * just do those two steps yourself.</p>

View File

@ -118,7 +118,7 @@ public interface IPaymentChannelClient {
/** /**
* <p>Indicates the channel has been successfully opened and * <p>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.</p> * may be called at will.</p>
* *
* <p>Called while holding a lock on the {@link com.google.bitcoin.protocols.channels.PaymentChannelClient} * <p>Called while holding a lock on the {@link com.google.bitcoin.protocols.channels.PaymentChannelClient}

View File

@ -120,7 +120,7 @@ public class PaymentChannelClientConnection {
* an error before the channel has reached the open state.</p> * an error before the channel has reached the open state.</p>
* *
* <p>After this future completes successfully, you may call * <p>After this future completes successfully, you may call
* {@link PaymentChannelClientConnection#incrementPayment(java.math.Coin)} to begin paying the server.</p> * {@link PaymentChannelClientConnection#incrementPayment(Coin)} to begin paying the server.</p>
*/ */
public ListenableFuture<PaymentChannelClientConnection> getChannelOpenFuture() { public ListenableFuture<PaymentChannelClientConnection> getChannelOpenFuture() {
return channelOpenFuture; return channelOpenFuture;

View File

@ -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. * 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. * start paying the server.
*/ */
public synchronized Transaction getMultisigContract() { public synchronized Transaction getMultisigContract() {

View File

@ -7,7 +7,7 @@ import java.util.Collection;
/** /**
* Represents the results of a * 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. * 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 * Different coin selections could be produced by different coin selectors from the same input set, according
* to their varying policies. * to their varying policies.