com.beowulfchain.beowulfj.protocol

Class Price

java.lang.Object

com.beowulfchain.beowulfj.protocol.Price

All Implemented Interfaces:

ByteTransformable

public class Price
extends Object
implements ByteTransformable

Constructor Summary

Constructors

Constructor and Description
Price(Asset base, Asset quote) Create a new price object by providing a base and a quote asset.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object otherObject)
Asset	getBase()
Asset	getQuote()
int	hashCode()
Asset	multiply(Asset asset) Multiply this price instance with an Asset instance.
void	setBase(Asset base)
void	setQuote(Asset quote)
byte[]	toByteArray() Covert the operation into a byte array.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Price

public Price(Asset base,
             Asset quote)

Create a new price object by providing a base and a quote asset. Represents quotation of the relative value of asset against another asset. Similar to 'currency pair' used to determine value of currencies. For example: 1 EUR / 1.25 USD where: 1 EUR is an asset specified as a base 1.25 USD us an asset specified as a quote can determine value of EUR against USD.

Parameters:

base - Represents a value of the Price object to be expressed relatively to quote asset.

quote - Represents an relative asset.

Throws:

InvalidParameterException - If the base, the quote or both objects have not been provided, contain the same symbol or have an amount less than 1.

Method Detail

getBase

public Asset getBase()

Returns:

The base asset.

setBase

public void setBase(Asset base)

Parameters:

base - The base asset to set.

Throws:

InvalidParameterException - If the base, the quote or both objects have not been provided, contain the same symbol or have an amount less than 1.

getQuote

public Asset getQuote()

Returns:

The quote asset.

setQuote

public void setQuote(Asset quote)

Parameters:

quote - The quote asset to set.

Throws:

InvalidParameterException - If the base, the quote or both objects have not been provided, contain the same symbol or have an amount less than 1.

multiply

public Asset multiply(Asset asset)

Multiply this price instance with an Asset instance.

Parameters:

asset - The asset to multiply.

Returns:

The asset multiplied with this price.

toByteArray

public byte[] toByteArray()
                   throws BeowulfInvalidTransactionException

Description copied from interface: ByteTransformable

Covert the operation into a byte array.

Specified by:

toByteArray in interface ByteTransformable

Returns:

The operation as a byte array.

Throws:

BeowulfInvalidTransactionException - If there was a problem while transforming the transaction into a byte array.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object otherObject)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object