Module org.joda.money

Package org.joda.money

Class MoneyUtils

java.lang.Object

org.joda.money.MoneyUtils

public final class MoneyUtils
extends java.lang.Object

Utilities for working with monetary values that handle null.

This utility class contains thread-safe static methods.

Method Summary

Modifier and Type	Method	Description
static BigMoney	add(BigMoney money1, BigMoney money2)	Adds two BigMoney objects, handling null.
static Money	add(Money money1, Money money2)	Adds two Money objects, handling null.
static boolean	isNegative(BigMoneyProvider moneyProvider)	Checks if the monetary value is negative and non-zero, treating null as zero.
static boolean	isNegativeOrZero(BigMoneyProvider moneyProvider)	Checks if the monetary value is negative or zero, treating null as zero.
static boolean	isPositive(BigMoneyProvider moneyProvider)	Checks if the monetary value is positive and non-zero, treating null as zero.
static boolean	isPositiveOrZero(BigMoneyProvider moneyProvider)	Checks if the monetary value is positive or zero, treating null as zero.
static boolean	isZero(BigMoneyProvider moneyProvider)	Checks if the monetary value is zero, treating null as zero.
static BigMoney	max(BigMoney money1, BigMoney money2)	Finds the maximum BigMoney value, handing null.
static Money	max(Money money1, Money money2)	Finds the maximum Money value, handing null.
static BigMoney	min(BigMoney money1, BigMoney money2)	Finds the minimum BigMoney value, handing null.
static Money	min(Money money1, Money money2)	Finds the minimum Money value, handing null.
static BigMoney	subtract(BigMoney money1, BigMoney money2)	Subtracts the second BigMoney from the first, handling null.
static Money	subtract(Money money1, Money money2)	Subtracts the second Money from the first, handling null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isZero

public static boolean isZero(BigMoneyProvider moneyProvider)

Checks if the monetary value is zero, treating null as zero.

This method accepts any implementation of BigMoneyProvider.

Parameters:

moneyProvider - the money to check, null returns zero

Returns:

true if the money is null or zero

isPositive

public static boolean isPositive(BigMoneyProvider moneyProvider)

Checks if the monetary value is positive and non-zero, treating null as zero.

This method accepts any implementation of BigMoneyProvider.

Parameters:

moneyProvider - the money to check, null returns false

Returns:

true if the money is non-null and positive

isPositiveOrZero

public static boolean isPositiveOrZero(BigMoneyProvider moneyProvider)

Checks if the monetary value is positive or zero, treating null as zero.

This method accepts any implementation of BigMoneyProvider.

Parameters:

moneyProvider - the money to check, null returns true

Returns:

true if the money is null, zero or positive

isNegative

public static boolean isNegative(BigMoneyProvider moneyProvider)

Checks if the monetary value is negative and non-zero, treating null as zero.

This method accepts any implementation of BigMoneyProvider.

Parameters:

moneyProvider - the money to check, null returns false

Returns:

true if the money is non-null and negative

isNegativeOrZero

public static boolean isNegativeOrZero(BigMoneyProvider moneyProvider)

Checks if the monetary value is negative or zero, treating null as zero.

This method accepts any implementation of BigMoneyProvider.

Parameters:

moneyProvider - the money to check, null returns true

Returns:

true if the money is null, zero or negative

max

public static Money max(Money money1,
                        Money money2)

Finds the maximum Money value, handing null.

This returns the greater of money1 or money2 where null is ignored. If both input values are null, then null is returned.

Parameters:

money1 - the first money instance, null returns money2

money2 - the first money instance, null returns money1

Returns:

the maximum value, null if both inputs are null

Throws:

CurrencyMismatchException - if the currencies differ

min

public static Money min(Money money1,
                        Money money2)

Finds the minimum Money value, handing null.

This returns the greater of money1 or money2 where null is ignored. If both input values are null, then null is returned.

Parameters:

money1 - the first money instance, null returns money2

money2 - the first money instance, null returns money1

Returns:

the minimum value, null if both inputs are null

Throws:

CurrencyMismatchException - if the currencies differ

add

public static Money add(Money money1,
                        Money money2)

Adds two Money objects, handling null.

This returns money1 + money2 where null is ignored. If both input values are null, then null is returned.

Parameters:

money1 - the first money instance, null returns money2

money2 - the first money instance, null returns money1

Returns:

the total, where null is ignored, null if both inputs are null

Throws:

CurrencyMismatchException - if the currencies differ

subtract

public static Money subtract(Money money1,
                             Money money2)

Subtracts the second Money from the first, handling null.

This returns money1 - money2 where null is ignored. If both input values are null, then null is returned.

Parameters:

money1 - the first money instance, null treated as zero

money2 - the first money instance, null returns money1

Returns:

the total, where null is ignored, null if both inputs are null

Throws:

CurrencyMismatchException - if the currencies differ

max

public static BigMoney max(BigMoney money1,
                           BigMoney money2)

Finds the maximum BigMoney value, handing null.

This returns the greater of money1 or money2 where null is ignored. If both input values are null, then null is returned.

Parameters:

money1 - the first money instance, null returns money2

money2 - the first money instance, null returns money1

Returns:

the maximum value, null if both inputs are null

Throws:

CurrencyMismatchException - if the currencies differ

min

public static BigMoney min(BigMoney money1,
                           BigMoney money2)

Finds the minimum BigMoney value, handing null.

This returns the greater of money1 or money2 where null is ignored. If both input values are null, then null is returned.

Parameters:

money1 - the first money instance, null returns money2

money2 - the first money instance, null returns money1

Returns:

the minimum value, null if both inputs are null

Throws:

CurrencyMismatchException - if the currencies differ

add

public static BigMoney add(BigMoney money1,
                           BigMoney money2)

Adds two BigMoney objects, handling null.

This returns money1 + money2 where null is ignored. If both input values are null, then null is returned.

Parameters:

money1 - the first money instance, null returns money2

money2 - the first money instance, null returns money1

Returns:

the total, where null is ignored, null if both inputs are null

Throws:

CurrencyMismatchException - if the currencies differ

subtract

public static BigMoney subtract(BigMoney money1,
                                BigMoney money2)

Subtracts the second BigMoney from the first, handling null.

This returns money1 - money2 where null is ignored. If both input values are null, then null is returned.

Parameters:

money1 - the first money instance, null treated as zero

money2 - the first money instance, null returns money1

Returns:

the total, where null is ignored, null if both inputs are null

Throws:

CurrencyMismatchException - if the currencies differ