com.squareup.square.models

Class Money

java.lang.Object

com.squareup.square.models.Money

public class Money
extends Object

This is a model class for Money type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Money.Builder Class to build instances of Money.

Constructor Summary

Constructors

Constructor and Description
Money(Long amount, String currency) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getAmount() Getter for Amount.
String	getCurrency() Getter for Currency.
int	hashCode()
Money.Builder	toBuilder() Builds a new Money.Builder object.
String	toString() Converts this Money into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Money

public Money(Long amount,
             String currency)

Initialization constructor.

Parameters:

amount - Long value for amount.

currency - String value for currency.

Method Detail

getAmount

public Long getAmount()

Getter for Amount. The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.

Returns:

Returns the Long

getCurrency

public String getCurrency()

Getter for Currency. Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this Money into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Money.Builder toBuilder()

Builds a new Money.Builder object. Creates the instance with the state of the current model.

Returns:

a new Money.Builder object