webfunds.token
Class TokenDead

java.lang.Object
  |
  +--webfunds.sox.Encodable
        |
        +--webfunds.token.Token
              |
              +--webfunds.token.TokenDead

public abstract class TokenDead
extends Token

This class represents a dead token for recovery purposes. Once spent and the user no longer requires a record of the coin, this can be used as a place marker with no info. If found in recovery, kill it. Hmm. Should have an ID.

See Also:
Serialized Form

Field Summary
static int DEAD_ORIGINAL
          The version number for this structure: 0: current
static int TOK_DEAD
          The state that the token is in within this phase (generally made by the mint according to the protocol).
 
Fields inherited from class webfunds.token.Token
expiry, item, log, phase, PHASE_BUILDER, PHASE_DEAD, PHASE_SIGNER, PHASE_SPEND, phaseVersion, ps, series, state, subversion, TOK_ORIGINAL, type
 
Constructor Summary
TokenDead()
          Create an uninitialised token.
TokenDead(byte[] buf)
          Construct a token object from a byte array that was previously returned from the encode() method of a token object.
TokenDead(java.io.InputStream is)
          Construct a token object from data in an input stream, where the data was previously returned from the encode() method of a token object.
 
Method Summary
abstract  void dead(byte[] uniqueId)
           
 void decode(java.io.InputStream is)
          Update this token object with the values from a token encoded as a byte array (such as previously returned from the encode() method of a token object).
 void encode(java.io.OutputStream os)
          Encode a token as a byte array, suitable for sending to third parties for depositing.
 java.lang.String toString()
           
 
Methods inherited from class webfunds.token.Token
equals, getExpiry, getItem, getLog, getPhase, getPhaseString, getPhaseVersion, getQty, getSeries, getState, getSubVersion, getType, getUniqueId, getVersion, isBuilder, isDead, isSigner, isSpender, isValidPhase, setState, vString
 
Methods inherited from class webfunds.sox.Encodable
decode, encode, main, readByteArray, readCertificate, readProperties, readString, writeByteArray, writeCertificate, writeProperties, writeString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEAD_ORIGINAL

public static final int DEAD_ORIGINAL
The version number for this structure: 0: current

TOK_DEAD

public static final int TOK_DEAD
The state that the token is in within this phase (generally made by the mint according to the protocol). How it is set and advanced is up to the higher layers. May be ignored, may use the following TOK numbers. Only the low-order single unsigned byte is saved & restored.
Constructor Detail

TokenDead

public TokenDead()
Create an uninitialised token. Call prototype() with some params to make it a real proto-token. The series is unknown until signing (mint can use a different key).
Parameters:
type - of token, being the blinding or coin scheme
subversion - is the version of the parent coin class
log - the coin size, log base 2 of quantity

TokenDead

public TokenDead(byte[] buf)
          throws TokenPacketException
Construct a token object from a byte array that was previously returned from the encode() method of a token object.
Parameters:
token - the previously encoded token

TokenDead

public TokenDead(java.io.InputStream is)
          throws TokenPacketException
Construct a token object from data in an input stream, where the data was previously returned from the encode() method of a token object.
Parameters:
is - the input stream from which to read the token data
Method Detail

dead

public abstract void dead(byte[] uniqueId)
Parameters:
uniqueId - is the one to kill during recovery

decode

public void decode(java.io.InputStream is)
            throws java.io.IOException
Update this token object with the values from a token encoded as a byte array (such as previously returned from the encode() method of a token object).
Overrides:
decode in class Token
Parameters:
token - the previosly encoded token

encode

public void encode(java.io.OutputStream os)
            throws java.io.IOException
Encode a token as a byte array, suitable for sending to third parties for depositing. If the signature is not present, an unsigned token will be encoded.
Overrides:
encode in class Token
Returns:
byte[] the token in encoded form

toString

public java.lang.String toString()
Overrides:
toString in class Token