From c40b7ce668f3664d546272a0ce0c889aefe91ecc Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Tue, 15 Mar 2011 14:04:38 +0000 Subject: [PATCH] Refresh JavaDocs. --- docs/allclasses-frame.html | 2 + docs/allclasses-noframe.html | 2 + docs/com/google/bitcoin/core/ECKey.html | 8 ++- docs/com/google/bitcoin/core/Utils.html | 1 + .../google/bitcoin/core/VersionMessage.html | 51 +++++++++++++++++-- docs/com/google/bitcoin/core/Wallet.html | 24 ++++++++- .../google/bitcoin/examples/PingService.html | 4 +- .../bitcoin/examples/package-frame.html | 2 + .../bitcoin/examples/package-summary.html | 4 ++ .../google/bitcoin/examples/package-tree.html | 2 +- docs/constant-values.html | 6 +++ docs/index-all.html | 20 +++++++- docs/overview-tree.html | 2 +- docs/serialized-form.html | 5 +- 14 files changed, 120 insertions(+), 13 deletions(-) diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html index e2390c1d..0c8375b3 100644 --- a/docs/allclasses-frame.html +++ b/docs/allclasses-frame.html @@ -31,6 +31,8 @@ All Classes
BlockChain
+DumpWallet +
ECKey
GetBlocksMessage diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html index fe19df5e..3e5dad0a 100644 --- a/docs/allclasses-noframe.html +++ b/docs/allclasses-noframe.html @@ -31,6 +31,8 @@ All Classes
BlockChain
+DumpWallet +
ECKey
GetBlocksMessage diff --git a/docs/com/google/bitcoin/core/ECKey.html b/docs/com/google/bitcoin/core/ECKey.html index 07759bf5..482476cf 100644 --- a/docs/com/google/bitcoin/core/ECKey.html +++ b/docs/com/google/bitcoin/core/ECKey.html @@ -181,7 +181,7 @@ Represents an elliptic curve keypair that we own and can use for signing transac toAddress(NetworkParameters params)
-            +          Returns the address that corresponds to the public part of this ECKey. @@ -301,7 +301,8 @@ getPubKey 
 public byte[] getPubKey()
-
Gets the raw public key value. +
Gets the raw public key value. This appears in transaction scriptSigs. Note that this is not the same + as the pubKeyHash/address.

@@ -331,6 +332,9 @@ toAddress 
 public Address toAddress(NetworkParameters params)
+
Returns the address that corresponds to the public part of this ECKey. Note that an address is derived from + the RIPEMD-160 hash of the public key and is not the public key itself (which is too large to be convenient). +

diff --git a/docs/com/google/bitcoin/core/Utils.html b/docs/com/google/bitcoin/core/Utils.html index 8a1608a0..0a409098 100644 --- a/docs/com/google/bitcoin/core/Utils.html +++ b/docs/com/google/bitcoin/core/Utils.html @@ -99,6 +99,7 @@ java.lang.Object

A collection of various utility methods that are helpful for working with the BitCoin protocol. + To enable debug logging from the library, run with -Dbitcoinj.logging=true on your command line.

diff --git a/docs/com/google/bitcoin/core/VersionMessage.html b/docs/com/google/bitcoin/core/VersionMessage.html index 9416c6da..b5b2e836 100644 --- a/docs/com/google/bitcoin/core/VersionMessage.html +++ b/docs/com/google/bitcoin/core/VersionMessage.html @@ -125,7 +125,7 @@ java.lang.Object - int + long localServices
@@ -134,10 +134,18 @@ java.lang.Object static int +NODE_NETWORK + +
+          A services flag that denotes whether the peer has a copy of the block chain or not. + + + +static int PROTOCOL_VERSION
-            +          The protocol version this library implements. @@ -199,6 +207,15 @@ java.lang.Object + boolean +hasBlockChain() + +
+          Returns true if the version message indicates the sender has a full copy of the block chain, + or if it's running in client mode (only has the headers). + + +  void parse() @@ -242,11 +259,25 @@ PROTOCOL_VERSION 

 public static final int PROTOCOL_VERSION
+
The protocol version this library implements. A value of 31800 means 0.3.18.00. +

See Also:
Constant Field Values
+

+NODE_NETWORK

+
+public static final int NODE_NETWORK
+
+
A services flag that denotes whether the peer has a copy of the block chain or not. +

+

+
See Also:
Constant Field Values
+
+
+

clientVersion

@@ -260,7 +291,7 @@ public int clientVersion

localServices

-public int localServices
+public long localServices
@@ -352,6 +383,20 @@ public void bitcoinSerializeToStream(java.io.OutputStream buf)
java.io.IOException
+
+ +

+hasBlockChain

+
+public boolean hasBlockChain()
+
+
Returns true if the version message indicates the sender has a full copy of the block chain, + or if it's running in client mode (only has the headers). +

+

+
+
+
diff --git a/docs/com/google/bitcoin/core/Wallet.html b/docs/com/google/bitcoin/core/Wallet.html index 8862f853..8f829383 100644 --- a/docs/com/google/bitcoin/core/Wallet.html +++ b/docs/com/google/bitcoin/core/Wallet.html @@ -233,6 +233,14 @@ A Wallet stores keys and a record of transactions that have not yet been spent.
          Sends coins to the given address, via the given Peer. + + + java.lang.String +toString() + +
+            +   @@ -240,7 +248,7 @@ A Wallet stores keys and a record of transactions that have not yet been spent. - +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  @@ -451,6 +459,20 @@ public java.math.BigInteger getBalance() +
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
diff --git a/docs/com/google/bitcoin/examples/PingService.html b/docs/com/google/bitcoin/examples/PingService.html index be854e49..c8b8f928 100644 --- a/docs/com/google/bitcoin/examples/PingService.html +++ b/docs/com/google/bitcoin/examples/PingService.html @@ -52,7 +52,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -221,7 +221,7 @@ public static void main(java.lang.String[] args) - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/docs/com/google/bitcoin/examples/package-frame.html b/docs/com/google/bitcoin/examples/package-frame.html index fa12ce69..1bae7211 100644 --- a/docs/com/google/bitcoin/examples/package-frame.html +++ b/docs/com/google/bitcoin/examples/package-frame.html @@ -21,6 +21,8 @@ com.google.bitcoin.examples Classes 
+DumpWallet +
PingService
PrivateKeys diff --git a/docs/com/google/bitcoin/examples/package-summary.html b/docs/com/google/bitcoin/examples/package-summary.html index f3005065..b3234037 100644 --- a/docs/com/google/bitcoin/examples/package-summary.html +++ b/docs/com/google/bitcoin/examples/package-summary.html @@ -86,6 +86,10 @@ Package com.google.bitcoin.examples Class Summary +DumpWallet +DumpWallet loads a serialized wallet and prints information about what it contains. + + PingService PingService demonstrates basic usage of the library. diff --git a/docs/com/google/bitcoin/examples/package-tree.html b/docs/com/google/bitcoin/examples/package-tree.html index e041b061..5046c83d 100644 --- a/docs/com/google/bitcoin/examples/package-tree.html +++ b/docs/com/google/bitcoin/examples/package-tree.html @@ -89,7 +89,7 @@ Class Hierarchy
diff --git a/docs/constant-values.html b/docs/constant-values.html index cef3b8e4..b1906301 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -172,6 +172,12 @@ com.google.* com.google.bitcoin.core.VersionMessage + +public static final int +NODE_NETWORK +1 + + public static final int PROTOCOL_VERSION diff --git a/docs/index-all.html b/docs/index-all.html index 99b512f7..2b4a375f 100644 --- a/docs/index-all.html +++ b/docs/index-all.html @@ -206,6 +206,9 @@ Static method in class com.google.bitcoin.core.doubleDigestTwoBuffers(byte[], int, int, byte[], int, int) - Static method in class com.google.bitcoin.core.Utils
Calculates SHA256(SHA256(byte range 1 + byte range 2)). +
DumpWallet - Class in com.google.bitcoin.examples
DumpWallet loads a serialized wallet and prints information about what it contains.
DumpWallet() - +Constructor for class com.google.bitcoin.examples.DumpWallet +
 

@@ -361,6 +364,10 @@ Method in class com.google.bitcoin.core.

H

+
hasBlockChain() - +Method in class com.google.bitcoin.core.VersionMessage +
Returns true if the version message indicates the sender has a full copy of the block chain, + or if it's running in client mode (only has the headers).
hash - Variable in class com.google.bitcoin.core.InventoryItem
  @@ -441,6 +448,9 @@ Variable in class com.google.bitcoin.core.

M

+
main(String[]) - +Static method in class com.google.bitcoin.examples.DumpWallet +
 
main(String[]) - Static method in class com.google.bitcoin.examples.PingService
  @@ -465,6 +475,9 @@ Constructor for class com.google.bitcoin.core.NetworkParameters - Class in com.google.bitcoin.core
NetworkParameters contains the data needed for working with an instantiation of a BitCoin chain.
NetworkParameters() - Constructor for class com.google.bitcoin.core.NetworkParameters
  +
NODE_NETWORK - +Static variable in class com.google.bitcoin.core.VersionMessage +
A services flag that denotes whether the peer has a copy of the block chain or not.

@@ -560,7 +573,7 @@ Variable in class com.google.bitcoin.core.PROTOCOL_VERSION - Static variable in class com.google.bitcoin.core.VersionMessage -
  +
The protocol version this library implements.
ProtocolException - Exception in com.google.bitcoin.core
 
ProtocolException(String) - Constructor for exception com.google.bitcoin.core.ProtocolException
  @@ -662,7 +675,7 @@ Variable in class com.google.bitcoin.core.toAddress(NetworkParameters) - Method in class com.google.bitcoin.core.ECKey -
  +
Returns the address that corresponds to the public part of this ECKey.
toNanoCoins(int, int) - Static method in class com.google.bitcoin.core.Utils
Convert an amount expressed in the way humans are used to into nanocoins. @@ -705,6 +718,9 @@ Method in class com.google.bitcoin.core.toString() - Method in class com.google.bitcoin.core.UnknownMessage
  +
toString() - +Method in class com.google.bitcoin.core.Wallet +
 
Transaction - Class in com.google.bitcoin.core
A transaction represents the movement of coins from some addresses to some other addresses.
Transaction(NetworkParameters, byte[]) - Constructor for class com.google.bitcoin.core.Transaction
Creates a transaction from the given serialized bytes, eg, from a block or a tx network message. diff --git a/docs/overview-tree.html b/docs/overview-tree.html index b4548ef4..8f29c6f1 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -88,7 +88,7 @@ Class Hierarchy

  • java.lang.Object
      -
    • com.google.bitcoin.core.Address
    • com.google.bitcoin.core.Base58
    • com.google.bitcoin.core.BlockChain
    • com.google.bitcoin.core.ECKey (implements java.io.Serializable) +
    • com.google.bitcoin.core.Address
    • com.google.bitcoin.core.Base58
    • com.google.bitcoin.core.BlockChain
    • com.google.bitcoin.examples.DumpWallet
    • com.google.bitcoin.core.ECKey (implements java.io.Serializable)
    • com.google.bitcoin.core.InventoryItem
    • com.google.bitcoin.core.Message (implements java.io.Serializable)
      • com.google.bitcoin.core.AddressMessage
      • com.google.bitcoin.core.Block
      • com.google.bitcoin.core.GetBlocksMessage
      • com.google.bitcoin.core.GetDataMessage
      • com.google.bitcoin.core.InventoryMessage
      • com.google.bitcoin.core.PeerAddress
      • com.google.bitcoin.core.Transaction (implements java.io.Serializable) diff --git a/docs/serialized-form.html b/docs/serialized-form.html index 7fa49946..a746bfc8 100644 --- a/docs/serialized-form.html +++ b/docs/serialized-form.html @@ -136,6 +136,9 @@ java.util.List<E> addresses +

        +serialVersionUID: 2738848929966035281L +

        @@ -791,7 +794,7 @@ int clientVersion

        localServices

        -int localServices
        +long localServices