Money (Commons core 1.4 API)

java.lang.Object
- cn.ponfee.commons.util.Money

所有已实现的接口:

Serializable, Cloneable, Comparable<Money>
```
public class Money
extends Object
implements Serializable, Comparable<Money>, Cloneable
```
Money definition based on Long numeric for minor currency unit representation.

作者:

Ponfee

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`Money.Fastjson` Custom deserialize Money based fastjson.
`static class`	`Money.JacksonDeserializer` Custom deserialize Money based jackson.
`static class`	`Money.JacksonSerializer` Custom serialize Money based jackson.

字段概要

字段
限定符和类型字段和说明

static String FIELD_NAME_CURRENCY

static String FIELD_NAME_NUMBER

字段
限定符和类型	字段和说明
`static String`	`FIELD_NAME_CURRENCY`
`static String`	`FIELD_NAME_NUMBER`

构造器概要

构造器
构造器和说明
`Money(Currency currency, long number)`
`Money(Currency currency, long majorUnitNumber, int minorUnitNumber)` Creates a MultiCurrencyMoney with majorUnitNumber, minorUnitNumber and currency

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Money`	`add(Money other)` Returns new Money object of the two money addition
`Money`	`addTo(Money other)` This money addition other money
`Money`	`clone()` Returns this object's clone
`int`	`compareTo(Money other)` Compares with other money object.
`Money`	`divide(BigDecimal val)`
`Money`	`divide(BigDecimal val, RoundingMode roundingMode)`
`Money`	`divideBy(BigDecimal val)`
`Money`	`divideBy(BigDecimal val, RoundingMode roundingMode)`
`boolean`	`equals(Money other)` Returns boolean of equals other money object
`boolean`	`equals(Object other)` Returns the specified object is the same currency and has same amount
`Currency`	`getCurrency()` Returns currency
`String`	`getCurrencyCode()` Returns currency code
`int`	`getFactor()` Returns currency scaling factor
`long`	`getNumber()`
`boolean`	`greaterThan(Money other)` Compares is greater than other money.
`int`	`hashCode()` Return this object's hash code
`Money`	`multiply(BigDecimal val)` Returns new Money object of this money multiply value
`Money`	`multiply(BigDecimal val, RoundingMode roundingMode)` Returns new Money object of this money multiply value
`Money`	`multiply(long val)` Returns new Money object of this money multiply value
`Money`	`multiplyBy(BigDecimal val)` This money multiply value factor
`Money`	`multiplyBy(BigDecimal val, RoundingMode roundingMode)` This money multiply value factor
`Money`	`multiplyBy(long val)` This money multiply value factor
`static Money`	`of(CurrencyEnum currencyEnum, long number)`
`static Money`	`of(Currency currency, long number)`
`static Money`	`of(String currencyCode, long number)`
`static Money`	`ofMajor(Currency currency, BigDecimal majorUnitNumber, RoundingMode roundingMode)` Creates a new Money instance with the specified currency, major number and rounding mode.
`static Money`	`ofMajor(CurrencyEnum currencyEnum, BigDecimal majorUnitNumber, RoundingMode roundingMode)`
`Money`	`ofMajor(CurrencyEnum currencyEnum, String majorUnitNumber, RoundingMode roundingMode)`
`Money`	`ofMajor(Currency currency, String majorUnitNumber, RoundingMode roundingMode)`
`static Money`	`ofMajor(String currencyCode, BigDecimal majorUnitNumber, RoundingMode roundingMode)`
`Money`	`ofMajor(String currencyCode, String majorUnitNumber, RoundingMode roundingMode)`
`void`	`setNumber(long number)` Set number
`Money[]`	`slice(int segment)` Average slice this money to segment part
`Money[]`	`slice(long[] ratios)` Slice this money with specified ratios
`Money`	`subtract(Money other)` Returns new Money object of the two money subtraction
`Money`	`subtractFrom(Money other)` This money subtraction other money
`BigDecimal`	`toMajorNumber()` Returns BigDecimal of major number string
`String`	`toMajorString()` Returns major number string
`String`	`toString()` Returns the string representation of this Money.
`static Money`	`zero(Currency currency)` Obtains an instance of `Money` representing zero at a specific currency.
`static Money`	`zero(CurrencyEnum currencyEnum)`
`static Money`	`zero(String currencyCode)`

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - FIELD_NAME_CURRENCY
```
public static final String FIELD_NAME_CURRENCY
```
    另请参阅:
    
    常量字段值
  - FIELD_NAME_NUMBER
```
public static final String FIELD_NAME_NUMBER
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - Money
```
public Money(Currency currency,
             long majorUnitNumber,
             int minorUnitNumber)
```
    Creates a MultiCurrencyMoney with majorUnitNumber, minorUnitNumber and currency
    
    参数:
    
    currency - the currency
    
    majorUnitNumber - the majorUnitNumber
    
    minorUnitNumber - the minorUnitNumber
  - Money
```
public Money(Currency currency,
             long number)
```
- 方法详细资料
  - of
```
public static Money of(Currency currency,
                       long number)
```
  - of
```
public static Money of(CurrencyEnum currencyEnum,
                       long number)
```
  - of
```
public static Money of(String currencyCode,
                       long number)
```
  - ofMajor
```
public Money ofMajor(CurrencyEnum currencyEnum,
                     String majorUnitNumber,
                     RoundingMode roundingMode)
```
  - ofMajor
```
public Money ofMajor(String currencyCode,
                     String majorUnitNumber,
                     RoundingMode roundingMode)
```
  - ofMajor
```
public Money ofMajor(Currency currency,
                     String majorUnitNumber,
                     RoundingMode roundingMode)
```
  - ofMajor
```
public static Money ofMajor(CurrencyEnum currencyEnum,
                            BigDecimal majorUnitNumber,
                            RoundingMode roundingMode)
```
  - ofMajor
```
public static Money ofMajor(String currencyCode,
                            BigDecimal majorUnitNumber,
                            RoundingMode roundingMode)
```
  - ofMajor
```
public static Money ofMajor(Currency currency,
                            BigDecimal majorUnitNumber,
                            RoundingMode roundingMode)
```
    Creates a new Money instance with the specified currency, major number and rounding mode.
    
    参数:
    
    currency - the currency
    
    majorUnitNumber - the major unit number
    
    roundingMode - the rounding mode
  - zero
```
public static Money zero(Currency currency)
```
    Obtains an instance of Money representing zero at a specific currency.
    For example, zero(USD) creates the instance USD 0.00.
    
    参数:
    
    currency - the currency, not null
    
    返回:
    
    the instance representing zero, never null
  - zero
```
public static Money zero(CurrencyEnum currencyEnum)
```
  - zero
```
public static Money zero(String currencyCode)
```
  - getCurrency
```
public Currency getCurrency()
```
    Returns currency
    
    返回:
    
    java.util.Currency object
  - getNumber
```
public long getNumber()
```
  - getCurrencyCode
```
public final String getCurrencyCode()
```
    Returns currency code
    
    返回:
    
    currency code
  - setNumber
```
public void setNumber(long number)
```
    Set number
    
    参数:
    
    number - the number
  - getFactor
```
public final int getFactor()
```
    Returns currency scaling factor
    
    返回:
    
    scaling factor
  - toMajorNumber
```
public BigDecimal toMajorNumber()
```
    Returns BigDecimal of major number string
    
    返回:
    
    major number BigDecimal
  - toMajorString
```
public String toMajorString()
```
    Returns major number string
    
    返回:
    
    major number string(e.g. USD$1.23 -> 1.23)
  - equals
```
public boolean equals(Object other)
```
    Returns the specified object is the same currency and has same amount
    
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    other - the other object
    
    返回:
    
    true if equals
    
    另请参阅:
    
    Object.equals(java.lang.Object)
  - equals
```
public boolean equals(Money other)
```
    Returns boolean of equals other money object
    
    参数:
    
    other - the other money
    
    返回:
    
    true if equals
  - hashCode
```
public int hashCode()
```
    Return this object's hash code
    
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    int value of hash code
    
    另请参阅:
    
    Object.hashCode()
  - clone
```
public Money clone()
```
    Returns this object's clone
    
    覆盖:
    
    clone 在类中 Object
    
    另请参阅:
    
    Object.clone()
  - toString
```
public String toString()
```
    Returns the string representation of this Money.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    money as string(e.g. $1.23)
  - compareTo
```
public int compareTo(Money other)
```
    Compares with other money object.
    
    指定者:
    
    compareTo 在接口中 Comparable<Money>
    
    参数:
    
    other - the other money.
    
    返回:
    
    -1: less, 0: equals, 1: greater
  - greaterThan
```
public boolean greaterThan(Money other)
```
    Compares is greater than other money.
    
    参数:
    
    other - the other money.
    
    返回:
    
    true if greater than other
  - add
```
public Money add(Money other)
```
    Returns new Money object of the two money addition
    
    参数:
    
    other - the other money.
    
    返回:
    
    new Money object of the two money addition
  - addTo
```
public Money addTo(Money other)
```
    This money addition other money
    
    参数:
    
    other - the other money
    
    返回:
    
    the caller money object(chain program)
  - subtract
```
public Money subtract(Money other)
```
    Returns new Money object of the two money subtraction
    
    参数:
    
    other - the other money.
    
    返回:
    
    new Money object of the two money subtraction
  - subtractFrom
```
public Money subtractFrom(Money other)
```
    This money subtraction other money
    
    参数:
    
    other - the other money
    
    返回:
    
    the caller money object(chain program)
  - multiply
```
public Money multiply(long val)
```
    Returns new Money object of this money multiply value
    
    参数:
    
    val - the value
    
    返回:
    
    new Money object of multiply result
  - multiplyBy
```
public Money multiplyBy(long val)
```
    This money multiply value factor
    
    参数:
    
    val - the value
    
    返回:
    
    the caller money object(chain program)
  - multiply
```
public Money multiply(BigDecimal val)
```
    Returns new Money object of this money multiply value
    
    参数:
    
    val - the value
    
    返回:
    
    new Money object of multiply result
  - multiplyBy
```
public Money multiplyBy(BigDecimal val)
```
    This money multiply value factor
    
    参数:
    
    val - the value
    
    返回:
    
    the caller money object(chain program)
  - multiply
```
public Money multiply(BigDecimal val,
                      RoundingMode roundingMode)
```
    Returns new Money object of this money multiply value
    
    参数:
    
    val - the value
    
    roundingMode - the rounding mode
    
    返回:
    
    new Money object of multiply result
  - multiplyBy
```
public Money multiplyBy(BigDecimal val,
                        RoundingMode roundingMode)
```
    This money multiply value factor
    
    参数:
    
    val - the value
    
    roundingMode - the rounding mode
    
    返回:
    
    the caller money object(chain program)
  - divide
```
public Money divide(BigDecimal val)
```
  - divide
```
public Money divide(BigDecimal val,
                    RoundingMode roundingMode)
```
  - divideBy
```
public Money divideBy(BigDecimal val)
```
  - divideBy
```
public Money divideBy(BigDecimal val,
                      RoundingMode roundingMode)
```
  - slice
```
public Money[] slice(int segment)
```
    Average slice this money to segment part
    
    参数:
    
    segment - the segment
    
    返回:
    
    Money array
  - slice
```
public Money[] slice(long[] ratios)
```
    Slice this money with specified ratios
    
    参数:
    
    ratios - the ratio
    
    返回:
    
    Money array

类 Money

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

FIELD_NAME_CURRENCY

FIELD_NAME_NUMBER

构造器详细资料

Money

Money

方法详细资料

of

of

of

ofMajor

ofMajor

ofMajor

ofMajor

ofMajor

ofMajor

zero

zero

zero

getCurrency

getNumber

getCurrencyCode

setNumber

getFactor

toMajorNumber

toMajorString

equals

equals

hashCode

clone

toString

compareTo

greaterThan

add

addTo

subtract

subtractFrom

multiply

multiplyBy

multiply

multiplyBy

multiply

multiplyBy

divide

divide

divideBy

divideBy

slice

slice