org.bitcoinj.core

Class VersionedChecksummedBytes

java.lang.Object

org.bitcoinj.core.VersionedChecksummedBytes

All Implemented Interfaces:

Serializable, Cloneable, Comparable<VersionedChecksummedBytes>

Direct Known Subclasses:

Address, BIP38PrivateKey, DumpedPrivateKey

public class VersionedChecksummedBytes
extends Object
implements Serializable, Cloneable, Comparable<VersionedChecksummedBytes>

In Bitcoin the following format is often used to represent some type of key:

[one version byte] [data bytes] [4 checksum bytes]

and the result is then Base58 encoded. This format is used for addresses, and private keys exported using the dumpprivkey command.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	bytes
protected int	version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VersionedChecksummedBytes(int version, byte[] bytes)
protected	VersionedChecksummedBytes(String encoded)

Method Summary

Modifier and Type	Method and Description
VersionedChecksummedBytes	clone() This implementation narrows the return type to VersionedChecksummedBytes and allows subclasses to throw CloneNotSupportedException even though it is never thrown by this implementation.
int	compareTo(VersionedChecksummedBytes o) This implementation uses an optimized Google Guava method to compare bytes.
boolean	equals(Object o)
int	getVersion() Returns the "version" or "header" byte: the first byte of the data.
int	hashCode()
String	toBase58() Returns the base-58 encoded String representation of this object, including version and checksum bytes.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

version

protected final int version

bytes

protected byte[] bytes

Constructor Detail

VersionedChecksummedBytes

protected VersionedChecksummedBytes(String encoded)
                             throws AddressFormatException

Throws:

AddressFormatException

VersionedChecksummedBytes

protected VersionedChecksummedBytes(int version,
                                    byte[] bytes)

Method Detail

toBase58

public final String toBase58()

Returns the base-58 encoded String representation of this object, including version and checksum bytes.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

clone

public VersionedChecksummedBytes clone()
                                throws CloneNotSupportedException

This implementation narrows the return type to VersionedChecksummedBytes and allows subclasses to throw CloneNotSupportedException even though it is never thrown by this implementation.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

compareTo

public int compareTo(VersionedChecksummedBytes o)

This implementation uses an optimized Google Guava method to compare bytes.

Specified by:

compareTo in interface Comparable<VersionedChecksummedBytes>

getVersion

public int getVersion()

Returns the "version" or "header" byte: the first byte of the data. This is used to disambiguate what the contents apply to, for example, which network the key or address is valid on.

Returns:

A positive number between 0 and 255.