com.scvngr.levelup.core.model

Class MonetaryValue

java.lang.Object

com.scvngr.levelup.core.model.MonetaryValue

All Implemented Interfaces:

Parcelable

@Immutable
 @LevelUpApi(contract=PUBLIC)
 @NonWrappable
public final class MonetaryValue
extends Object
implements Parcelable

Represents some amount of money on the server.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<MonetaryValue>	CREATOR Implements the Parcelable interface.
protected static String	USD_CODE The currency code for USD.
protected static String	USD_SYMBOL The symbol for USD.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
MonetaryValue(long amount) Constructor.
MonetaryValue(long amount, String currencyCode, String currencySymbol)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
long	getAmount() The amount (in cents) for this MonetaryValue.
String	getCurrencyCode() The raw currency code, such as "USD" or "EUR".
String	getCurrencySymbol() The currency symbol (i.e.: "$" or "€").
String	getFormattedAmountWithCurrencySymbol(Context context) Get the formatted currency amount with symbol, assuming standard US/European "symbol+amount" formatting.
String	getFormattedCentStrippedAmountWithCurrencySymbol(Context context) Get the formatted currency amount with symbol, assuming standard US/European "symbol+amount" formatting; drop the last digits and decimal/comma if they're all 0s.
static String	getFormattedMoney(Context context, String currencySymbol, long amount) Helper to format a long monetary value to a string.
static String	getFormattedMoneyNoDecimal(Context context, String currencySymbol, long amount) Helper to format a monetary value to a string, but truncate the decimals.
int	hashCode()
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<MonetaryValue> CREATOR

Implements the Parcelable interface.

USD_CODE

@VisibleForTesting(visibility=PRIVATE)
protected static final String USD_CODE

The currency code for USD.

See Also:

Constant Field Values

USD_SYMBOL

@VisibleForTesting(visibility=PRIVATE)
protected static final String USD_SYMBOL

The symbol for USD.

See Also:

Constant Field Values

Constructor Detail

MonetaryValue

public MonetaryValue(long amount)

Constructor. Assumes USD.

Parameters:

amount - the amount (in cents) for this MonetaryValue.

MonetaryValue

public MonetaryValue(long amount,
                     String currencyCode,
                     String currencySymbol)

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

getFormattedAmountWithCurrencySymbol

public String getFormattedAmountWithCurrencySymbol(Context context)

Get the formatted currency amount with symbol, assuming standard US/European "symbol+amount" formatting.

Parameters:

context - the Application context.

Returns:

the amount formatted with the currency symbol and amount (e.g. "$20" or "$23.05")

getFormattedCentStrippedAmountWithCurrencySymbol

public String getFormattedCentStrippedAmountWithCurrencySymbol(Context context)

Get the formatted currency amount with symbol, assuming standard US/European "symbol+amount" formatting; drop the last digits and decimal/comma if they're all 0s.

Parameters:

context - the Application context.

Returns:

the amount formatted with the currency symbol and amount (e.g. "$20" or "$23.05")

getFormattedMoney

public static String getFormattedMoney(Context context,
                                       String currencySymbol,
                                       long amount)

Helper to format a long monetary value to a string. NOTE: this is not internationalized. It assumes that the value is in "cents".

Parameters:

context - the Application context.

currencySymbol - the symbol for the currency of the money.

amount - the amount of money.

Returns:

String with the formatted amount.

getFormattedMoneyNoDecimal

public static String getFormattedMoneyNoDecimal(Context context,
                                                String currencySymbol,
                                                long amount)

Helper to format a monetary value to a string, but truncate the decimals. The value is rounded to the nearest whole dollar. NOTE: this is not internationalized. It assumes that the value is in "cents".

Parameters:

context - the Application context.

currencySymbol - the symbol for the currency of the money.

amount - the amount of money.

Returns:

String with the formatted amount rounded to the nearest whole dollar, with no cents.

getAmount

public long getAmount()

The amount (in cents) for this MonetaryValue.

getCurrencyCode

public String getCurrencyCode()

The raw currency code, such as "USD" or "EUR".

getCurrencySymbol

public String getCurrencySymbol()

The currency symbol (i.e.: "$" or "€").

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