org.bitcoinj.wallet

Class Protos.Key.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder<BuilderType>

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.Builder<Protos.Key.Builder>

org.bitcoinj.wallet.Protos.Key.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Protos.KeyOrBuilder

Enclosing class:

Protos.Key

public static final class Protos.Key.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Protos.Key.Builder>
implements Protos.KeyOrBuilder

Protobuf type wallet.Key

 A key used to control Bitcoin spending.

 Either the private key, the public key or both may be present.  It is recommended that
 if the private key is provided that the public key is provided too because deriving it is slow.

 If only the public key is provided, the key can only be used to watch the blockchain and verify
 transactions, and not for spending.
 

Method Summary

Modifier and Type	Method and Description
Protos.Key	build()
Protos.Key	buildPartial()
Protos.Key.Builder	clear()
Protos.Key.Builder	clearCreationTimestamp() optional int64 creation_timestamp = 5;
Protos.Key.Builder	clearDeterministicKey() optional .wallet.DeterministicKey deterministic_key = 7;
Protos.Key.Builder	clearDeterministicSeed() optional bytes deterministic_seed = 8;
Protos.Key.Builder	clearEncryptedData() optional .wallet.EncryptedData encrypted_data = 6;
Protos.Key.Builder	clearEncryptedDeterministicSeed() optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
Protos.Key.Builder	clearLabel() optional string label = 4;
Protos.Key.Builder	clearPublicKey() optional bytes public_key = 3;
Protos.Key.Builder	clearSecretBytes() optional bytes secret_bytes = 2;
Protos.Key.Builder	clearType() required .wallet.Key.Type type = 1;
Protos.Key.Builder	clone()
long	getCreationTimestamp() optional int64 creation_timestamp = 5;
Protos.Key	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Protos.DeterministicKey	getDeterministicKey() optional .wallet.DeterministicKey deterministic_key = 7;
Protos.DeterministicKey.Builder	getDeterministicKeyBuilder() optional .wallet.DeterministicKey deterministic_key = 7;
Protos.DeterministicKeyOrBuilder	getDeterministicKeyOrBuilder() optional .wallet.DeterministicKey deterministic_key = 7;
com.google.protobuf.ByteString	getDeterministicSeed() optional bytes deterministic_seed = 8;
Protos.EncryptedData	getEncryptedData() optional .wallet.EncryptedData encrypted_data = 6;
Protos.EncryptedData.Builder	getEncryptedDataBuilder() optional .wallet.EncryptedData encrypted_data = 6;
Protos.EncryptedDataOrBuilder	getEncryptedDataOrBuilder() optional .wallet.EncryptedData encrypted_data = 6;
Protos.EncryptedData	getEncryptedDeterministicSeed() optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
Protos.EncryptedData.Builder	getEncryptedDeterministicSeedBuilder() optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
Protos.EncryptedDataOrBuilder	getEncryptedDeterministicSeedOrBuilder() optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
String	getLabel() optional string label = 4;
com.google.protobuf.ByteString	getLabelBytes() optional string label = 4;
com.google.protobuf.ByteString	getPublicKey() optional bytes public_key = 3;
com.google.protobuf.ByteString	getSecretBytes() optional bytes secret_bytes = 2;
Protos.Key.Type	getType() required .wallet.Key.Type type = 1;
boolean	hasCreationTimestamp() optional int64 creation_timestamp = 5;
boolean	hasDeterministicKey() optional .wallet.DeterministicKey deterministic_key = 7;
boolean	hasDeterministicSeed() optional bytes deterministic_seed = 8;
boolean	hasEncryptedData() optional .wallet.EncryptedData encrypted_data = 6;
boolean	hasEncryptedDeterministicSeed() optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
boolean	hasLabel() optional string label = 4;
boolean	hasPublicKey() optional bytes public_key = 3;
boolean	hasSecretBytes() optional bytes secret_bytes = 2;
boolean	hasType() required .wallet.Key.Type type = 1;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Protos.Key.Builder	mergeDeterministicKey(Protos.DeterministicKey value) optional .wallet.DeterministicKey deterministic_key = 7;
Protos.Key.Builder	mergeEncryptedData(Protos.EncryptedData value) optional .wallet.EncryptedData encrypted_data = 6;
Protos.Key.Builder	mergeEncryptedDeterministicSeed(Protos.EncryptedData value) optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
Protos.Key.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Protos.Key.Builder	mergeFrom(com.google.protobuf.Message other)
Protos.Key.Builder	mergeFrom(Protos.Key other)
Protos.Key.Builder	setCreationTimestamp(long value) optional int64 creation_timestamp = 5;
Protos.Key.Builder	setDeterministicKey(Protos.DeterministicKey.Builder builderForValue) optional .wallet.DeterministicKey deterministic_key = 7;
Protos.Key.Builder	setDeterministicKey(Protos.DeterministicKey value) optional .wallet.DeterministicKey deterministic_key = 7;
Protos.Key.Builder	setDeterministicSeed(com.google.protobuf.ByteString value) optional bytes deterministic_seed = 8;
Protos.Key.Builder	setEncryptedData(Protos.EncryptedData.Builder builderForValue) optional .wallet.EncryptedData encrypted_data = 6;
Protos.Key.Builder	setEncryptedData(Protos.EncryptedData value) optional .wallet.EncryptedData encrypted_data = 6;
Protos.Key.Builder	setEncryptedDeterministicSeed(Protos.EncryptedData.Builder builderForValue) optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
Protos.Key.Builder	setEncryptedDeterministicSeed(Protos.EncryptedData value) optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
Protos.Key.Builder	setLabel(String value) optional string label = 4;
Protos.Key.Builder	setLabelBytes(com.google.protobuf.ByteString value) optional string label = 4;
Protos.Key.Builder	setPublicKey(com.google.protobuf.ByteString value) optional bytes public_key = 3;
Protos.Key.Builder	setSecretBytes(com.google.protobuf.ByteString value) optional bytes secret_bytes = 2;
Protos.Key.Builder	setType(Protos.Key.Type value) required .wallet.Key.Type type = 1;

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, getAllFields, getField, getFieldBuilder, getParentForChildren, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Protos.Key.Builder>

clear

public Protos.Key.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Protos.Key.Builder>

clone

public Protos.Key.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessage.Builder<Protos.Key.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Protos.Key.Builder>

getDefaultInstanceForType

public Protos.Key getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Protos.Key build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Protos.Key buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Protos.Key.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Protos.Key.Builder>

mergeFrom

public Protos.Key.Builder mergeFrom(Protos.Key other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Protos.Key.Builder>

mergeFrom

public Protos.Key.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Protos.Key.Builder>

Throws:

IOException

hasType

public boolean hasType()

required .wallet.Key.Type type = 1;

Specified by:

hasType in interface Protos.KeyOrBuilder

getType

public Protos.Key.Type getType()

required .wallet.Key.Type type = 1;

Specified by:

getType in interface Protos.KeyOrBuilder

setType

public Protos.Key.Builder setType(Protos.Key.Type value)

required .wallet.Key.Type type = 1;

clearType

public Protos.Key.Builder clearType()

required .wallet.Key.Type type = 1;

hasSecretBytes

public boolean hasSecretBytes()

optional bytes secret_bytes = 2;

 Either the private EC key bytes (without any ASN.1 wrapping), or the deterministic root seed.
 If the secret is encrypted, or this is a "watching entry" then this is missing.
 

Specified by:

hasSecretBytes in interface Protos.KeyOrBuilder

getSecretBytes

public com.google.protobuf.ByteString getSecretBytes()

optional bytes secret_bytes = 2;

 Either the private EC key bytes (without any ASN.1 wrapping), or the deterministic root seed.
 If the secret is encrypted, or this is a "watching entry" then this is missing.
 

Specified by:

getSecretBytes in interface Protos.KeyOrBuilder

setSecretBytes

public Protos.Key.Builder setSecretBytes(com.google.protobuf.ByteString value)

optional bytes secret_bytes = 2;

 Either the private EC key bytes (without any ASN.1 wrapping), or the deterministic root seed.
 If the secret is encrypted, or this is a "watching entry" then this is missing.
 

clearSecretBytes

public Protos.Key.Builder clearSecretBytes()

optional bytes secret_bytes = 2;

 Either the private EC key bytes (without any ASN.1 wrapping), or the deterministic root seed.
 If the secret is encrypted, or this is a "watching entry" then this is missing.
 

hasEncryptedData

public boolean hasEncryptedData()

optional .wallet.EncryptedData encrypted_data = 6;

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

Specified by:

hasEncryptedData in interface Protos.KeyOrBuilder

getEncryptedData

public Protos.EncryptedData getEncryptedData()

optional .wallet.EncryptedData encrypted_data = 6;

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

Specified by:

getEncryptedData in interface Protos.KeyOrBuilder

setEncryptedData

public Protos.Key.Builder setEncryptedData(Protos.EncryptedData value)

optional .wallet.EncryptedData encrypted_data = 6;

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

setEncryptedData

public Protos.Key.Builder setEncryptedData(Protos.EncryptedData.Builder builderForValue)

optional .wallet.EncryptedData encrypted_data = 6;

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

mergeEncryptedData

public Protos.Key.Builder mergeEncryptedData(Protos.EncryptedData value)

optional .wallet.EncryptedData encrypted_data = 6;

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

clearEncryptedData

public Protos.Key.Builder clearEncryptedData()

optional .wallet.EncryptedData encrypted_data = 6;

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

getEncryptedDataBuilder

public Protos.EncryptedData.Builder getEncryptedDataBuilder()

optional .wallet.EncryptedData encrypted_data = 6;

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

getEncryptedDataOrBuilder

public Protos.EncryptedDataOrBuilder getEncryptedDataOrBuilder()

optional .wallet.EncryptedData encrypted_data = 6;

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

Specified by:

getEncryptedDataOrBuilder in interface Protos.KeyOrBuilder

hasPublicKey

public boolean hasPublicKey()

optional bytes public_key = 3;

 The public EC key derived from the private key. We allow both to be stored to avoid mobile clients having to
 do lots of slow EC math on startup. For DETERMINISTIC_MNEMONIC entries this is missing.
 

Specified by:

hasPublicKey in interface Protos.KeyOrBuilder

getPublicKey

public com.google.protobuf.ByteString getPublicKey()

optional bytes public_key = 3;

 The public EC key derived from the private key. We allow both to be stored to avoid mobile clients having to
 do lots of slow EC math on startup. For DETERMINISTIC_MNEMONIC entries this is missing.
 

Specified by:

getPublicKey in interface Protos.KeyOrBuilder

setPublicKey

public Protos.Key.Builder setPublicKey(com.google.protobuf.ByteString value)

optional bytes public_key = 3;

 The public EC key derived from the private key. We allow both to be stored to avoid mobile clients having to
 do lots of slow EC math on startup. For DETERMINISTIC_MNEMONIC entries this is missing.
 

clearPublicKey

public Protos.Key.Builder clearPublicKey()

optional bytes public_key = 3;

 The public EC key derived from the private key. We allow both to be stored to avoid mobile clients having to
 do lots of slow EC math on startup. For DETERMINISTIC_MNEMONIC entries this is missing.
 

hasLabel

public boolean hasLabel()

optional string label = 4;

 User-provided label associated with the key.
 

Specified by:

hasLabel in interface Protos.KeyOrBuilder

getLabel

public String getLabel()

optional string label = 4;

 User-provided label associated with the key.
 

Specified by:

getLabel in interface Protos.KeyOrBuilder

getLabelBytes

public com.google.protobuf.ByteString getLabelBytes()

optional string label = 4;

 User-provided label associated with the key.
 

Specified by:

getLabelBytes in interface Protos.KeyOrBuilder

setLabel

public Protos.Key.Builder setLabel(String value)

optional string label = 4;

 User-provided label associated with the key.
 

clearLabel

public Protos.Key.Builder clearLabel()

optional string label = 4;

 User-provided label associated with the key.
 

setLabelBytes

public Protos.Key.Builder setLabelBytes(com.google.protobuf.ByteString value)

optional string label = 4;

 User-provided label associated with the key.
 

hasCreationTimestamp

public boolean hasCreationTimestamp()

optional int64 creation_timestamp = 5;

 Timestamp stored as millis since epoch. Useful for skipping block bodies before this point. Only reason it's
 optional is that some very old wallets don't have this data.
 

Specified by:

hasCreationTimestamp in interface Protos.KeyOrBuilder

getCreationTimestamp

public long getCreationTimestamp()

optional int64 creation_timestamp = 5;

 Timestamp stored as millis since epoch. Useful for skipping block bodies before this point. Only reason it's
 optional is that some very old wallets don't have this data.
 

Specified by:

getCreationTimestamp in interface Protos.KeyOrBuilder

setCreationTimestamp

public Protos.Key.Builder setCreationTimestamp(long value)

optional int64 creation_timestamp = 5;

 Timestamp stored as millis since epoch. Useful for skipping block bodies before this point. Only reason it's
 optional is that some very old wallets don't have this data.
 

clearCreationTimestamp

public Protos.Key.Builder clearCreationTimestamp()

optional int64 creation_timestamp = 5;

 Timestamp stored as millis since epoch. Useful for skipping block bodies before this point. Only reason it's
 optional is that some very old wallets don't have this data.
 

hasDeterministicKey

public boolean hasDeterministicKey()

optional .wallet.DeterministicKey deterministic_key = 7;

Specified by:

hasDeterministicKey in interface Protos.KeyOrBuilder

getDeterministicKey

public Protos.DeterministicKey getDeterministicKey()

optional .wallet.DeterministicKey deterministic_key = 7;

Specified by:

getDeterministicKey in interface Protos.KeyOrBuilder

setDeterministicKey

public Protos.Key.Builder setDeterministicKey(Protos.DeterministicKey value)

optional .wallet.DeterministicKey deterministic_key = 7;

setDeterministicKey

public Protos.Key.Builder setDeterministicKey(Protos.DeterministicKey.Builder builderForValue)

optional .wallet.DeterministicKey deterministic_key = 7;

mergeDeterministicKey

public Protos.Key.Builder mergeDeterministicKey(Protos.DeterministicKey value)

optional .wallet.DeterministicKey deterministic_key = 7;

clearDeterministicKey

public Protos.Key.Builder clearDeterministicKey()

optional .wallet.DeterministicKey deterministic_key = 7;

getDeterministicKeyBuilder

public Protos.DeterministicKey.Builder getDeterministicKeyBuilder()

optional .wallet.DeterministicKey deterministic_key = 7;

getDeterministicKeyOrBuilder

public Protos.DeterministicKeyOrBuilder getDeterministicKeyOrBuilder()

optional .wallet.DeterministicKey deterministic_key = 7;

Specified by:

getDeterministicKeyOrBuilder in interface Protos.KeyOrBuilder

hasDeterministicSeed

public boolean hasDeterministicSeed()

optional bytes deterministic_seed = 8;

 The seed for a deterministic key hierarchy.  Derived from the mnemonic,
 but cached here for quick startup.  Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

Specified by:

hasDeterministicSeed in interface Protos.KeyOrBuilder

getDeterministicSeed

public com.google.protobuf.ByteString getDeterministicSeed()

optional bytes deterministic_seed = 8;

 The seed for a deterministic key hierarchy.  Derived from the mnemonic,
 but cached here for quick startup.  Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

Specified by:

getDeterministicSeed in interface Protos.KeyOrBuilder

setDeterministicSeed

public Protos.Key.Builder setDeterministicSeed(com.google.protobuf.ByteString value)

optional bytes deterministic_seed = 8;

 The seed for a deterministic key hierarchy.  Derived from the mnemonic,
 but cached here for quick startup.  Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

clearDeterministicSeed

public Protos.Key.Builder clearDeterministicSeed()

optional bytes deterministic_seed = 8;

 The seed for a deterministic key hierarchy.  Derived from the mnemonic,
 but cached here for quick startup.  Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

hasEncryptedDeterministicSeed

public boolean hasEncryptedDeterministicSeed()

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

Specified by:

hasEncryptedDeterministicSeed in interface Protos.KeyOrBuilder

getEncryptedDeterministicSeed

public Protos.EncryptedData getEncryptedDeterministicSeed()

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

Specified by:

getEncryptedDeterministicSeed in interface Protos.KeyOrBuilder

setEncryptedDeterministicSeed

public Protos.Key.Builder setEncryptedDeterministicSeed(Protos.EncryptedData value)

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

setEncryptedDeterministicSeed

public Protos.Key.Builder setEncryptedDeterministicSeed(Protos.EncryptedData.Builder builderForValue)

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

mergeEncryptedDeterministicSeed

public Protos.Key.Builder mergeEncryptedDeterministicSeed(Protos.EncryptedData value)

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

clearEncryptedDeterministicSeed

public Protos.Key.Builder clearEncryptedDeterministicSeed()

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

getEncryptedDeterministicSeedBuilder

public Protos.EncryptedData.Builder getEncryptedDeterministicSeedBuilder()

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

getEncryptedDeterministicSeedOrBuilder

public Protos.EncryptedDataOrBuilder getEncryptedDeterministicSeedOrBuilder()

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

Specified by:

getEncryptedDeterministicSeedOrBuilder in interface Protos.KeyOrBuilder