Package org.stellar.sdk.xdr

Class StellarValue

java.lang.Object

org.stellar.sdk.xdr.StellarValue

All Implemented Interfaces:

XdrElement

public class StellarValue
extends Object
implements XdrElement

StellarValue's original definition in the XDR file is:

 struct StellarValue
 {
     Hash txSetHash;      // transaction set to apply to previous ledger
     TimePoint closeTime; // network close time

     // upgrades to apply to the previous ledger (usually empty)
     // this is a vector of encoded 'LedgerUpgrade' so that nodes can drop
     // unknown steps during consensus if needed.
     // see notes below on 'LedgerUpgrade' for more detail
     // max size is dictated by number of upgrade types (+ room for future)
     UpgradeType upgrades<6>;

     // reserved for future use
     union switch (StellarValueType v)
     {
     case STELLAR_VALUE_BASIC:
         void;
     case STELLAR_VALUE_SIGNED:
         LedgerCloseValueSignature lcValueSignature;
     }
     ext;
 };
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StellarValue.StellarValueBuilder
static class	StellarValue.StellarValueExt	StellarValueExt's original definition in the XDR file is:

Field Summary

Fields inherited from interface org.stellar.sdk.xdr.XdrElement

gson

Constructor Summary

Constructors

Constructor	Description
StellarValue()
StellarValue(Hash txSetHash, TimePoint closeTime, UpgradeType[] upgrades, StellarValue.StellarValueExt ext)	Creates a new StellarValue instance.

Method Summary

Modifier and Type	Method	Description
static StellarValue.StellarValueBuilder	builder()
static StellarValue	decode(XdrDataInputStream stream)
static StellarValue	decode(XdrDataInputStream stream, int maxDepth)
void	encode(XdrDataOutputStream stream)	Encodes this value to XDR and writes it to the provided stream.
boolean	equals(Object o)
static StellarValue	fromJson(String json)
static StellarValue	fromXdrBase64(String xdr)
static StellarValue	fromXdrByteArray(byte[] xdr)
TimePoint	getCloseTime()	Value of the closeTime field.
StellarValue.StellarValueExt	getExt()	Value of the ext field.
Hash	getTxSetHash()	Value of the txSetHash field.
UpgradeType[]	getUpgrades()	Value of the upgrades field.
int	hashCode()
void	setCloseTime(TimePoint closeTime)	Value of the closeTime field.
void	setExt(StellarValue.StellarValueExt ext)	Value of the ext field.
void	setTxSetHash(Hash txSetHash)	Value of the txSetHash field.
void	setUpgrades(UpgradeType[] upgrades)	Value of the upgrades field.
StellarValue.StellarValueBuilder	toBuilder()
String	toJson()	Serializes this value to JSON.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.stellar.sdk.xdr.XdrElement

toXdrBase64, toXdrByteArray

Constructor Details

StellarValue

public StellarValue()

StellarValue

public StellarValue(Hash txSetHash,
 TimePoint closeTime,
 UpgradeType[] upgrades,
 StellarValue.StellarValueExt ext)

Creates a new StellarValue instance.

Parameters:

txSetHash - the txSetHash field value

closeTime - the closeTime field value

upgrades - the upgrades field value

ext - the ext field value

Method Details

encode

public void encode(XdrDataOutputStream stream)
            throws IOException

Description copied from interface: XdrElement

Encodes this value to XDR and writes it to the provided stream.

Specified by:

encode in interface XdrElement

Parameters:

stream - the destination XDR output stream

Throws:

IOException - if an I/O error occurs while writing the value

decode

public static StellarValue decode(XdrDataInputStream stream,
 int maxDepth)
                           throws IOException

Throws:

IOException

decode

public static StellarValue decode(XdrDataInputStream stream)
                           throws IOException

Throws:

IOException

fromXdrBase64

public static StellarValue fromXdrBase64(String xdr)
                                  throws IOException

Throws:

IOException

fromXdrByteArray

public static StellarValue fromXdrByteArray(byte[] xdr)
                                     throws IOException

Throws:

IOException

toJson

public String toJson()

Description copied from interface: XdrElement

Serializes this value to JSON.

Specified by:

toJson in interface XdrElement

Returns:

the JSON representation of this value

fromJson

public static StellarValue fromJson(String json)

builder

public static StellarValue.StellarValueBuilder builder()

toBuilder

public StellarValue.StellarValueBuilder toBuilder()

getTxSetHash

public Hash getTxSetHash()

Value of the txSetHash field.

Returns:

the txSetHash field value

getCloseTime

public TimePoint getCloseTime()

Value of the closeTime field.

Returns:

the closeTime field value

getUpgrades

public UpgradeType[] getUpgrades()

Value of the upgrades field.

Returns:

the upgrades field value

getExt

public StellarValue.StellarValueExt getExt()

Value of the ext field.

Returns:

the ext field value

setTxSetHash

public void setTxSetHash(Hash txSetHash)

Value of the txSetHash field.

Parameters:

txSetHash - the txSetHash field value

setCloseTime

public void setCloseTime(TimePoint closeTime)

Value of the closeTime field.

Parameters:

closeTime - the closeTime field value

setUpgrades

public void setUpgrades(UpgradeType[] upgrades)

Value of the upgrades field.

Parameters:

upgrades - the upgrades field value

setExt

public void setExt(StellarValue.StellarValueExt ext)

Value of the ext field.

Parameters:

ext - the ext field value

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object