java.math

Class MathContext

java.lang.Object

java.math.MathContext

All Implemented Interfaces:

Serializable

public final class MathContext
extends Object
implements Serializable

Immutable objects describing settings such as rounding mode and digit precision for numerical operations such as those in the BigDecimal class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MathContext	DECIMAL128 A MathContext for the IEEE 754R Decimal128 format - 34 digit preicision and HALF_EVEN rounding.
static MathContext	DECIMAL32 A MathContext for the IEEE 754R Decimal32 format - 7 digit preicision and HALF_EVEN rounding.
static MathContext	DECIMAL64 A MathContext for the IEEE 754R Decimal64 format - 16 digit preicision and HALF_EVEN rounding.
static MathContext	UNLIMITED A MathContext for unlimited precision arithmetic *

Constructor Summary

Constructors

Constructor and Description
MathContext(int setPrecision) Constructs a new MathContext with the specified precision and with HALF_UP rounding.
MathContext(int setPrecision, RoundingMode setRoundingMode) Constructs a new MathContext with the specified precision and rounding mode.
MathContext(String val) Constructs a MathContext from a String that has the same form as one produced by the toString() method.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object x) Returns true if x is a MathContext and has the same precision setting and rounding mode as this MathContext.
int	getPrecision() Returns the precision setting.
RoundingMode	getRoundingMode() Returns the rounding mode setting.
int	hashCode() Returns the hashcode for this MathContext.
String	toString() Returns "precision=p roundingMode=MODE" where p is an int giving the precision and MODE is UP, DOWN, HALF_UP, HALF_DOWN, HALF_EVEN, CEILING, FLOOR, or UNNECESSARY corresponding to rounding modes.

Methods inherited from class java.lang.Object

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

Field Detail

UNLIMITED

public static final MathContext UNLIMITED

A MathContext for unlimited precision arithmetic *

DECIMAL32

public static final MathContext DECIMAL32

A MathContext for the IEEE 754R Decimal32 format - 7 digit preicision and HALF_EVEN rounding.

DECIMAL64

public static final MathContext DECIMAL64

A MathContext for the IEEE 754R Decimal64 format - 16 digit preicision and HALF_EVEN rounding.

DECIMAL128

public static final MathContext DECIMAL128

A MathContext for the IEEE 754R Decimal128 format - 34 digit preicision and HALF_EVEN rounding.

Constructor Detail

MathContext

public MathContext(int setPrecision)

Constructs a new MathContext with the specified precision and with HALF_UP rounding.

Parameters:

setPrecision - the precision for the new MathContext

Throws:

IllegalArgumentException - if precision is < 0.

MathContext

public MathContext(int setPrecision,
           RoundingMode setRoundingMode)

Constructs a new MathContext with the specified precision and rounding mode.

Parameters:

setPrecision - the precision

setRoundingMode - the rounding mode

Throws:

IllegalArgumentException - if precision is < 0.

MathContext

public MathContext(String val)

Constructs a MathContext from a String that has the same form as one produced by the toString() method.

Parameters:

val -

Throws:

IllegalArgumentException - if the String is not in the correct format or if the precision specified is < 0.

Method Detail

equals

public boolean equals(Object x)

Returns true if x is a MathContext and has the same precision setting and rounding mode as this MathContext.

Overrides:

equals in class Object

Parameters:

x - the Object to compare to

Returns:

true if the above conditions hold

See Also:

Object.hashCode()

getPrecision

public int getPrecision()

Returns the precision setting.

Returns:

the precision setting.

getRoundingMode

public RoundingMode getRoundingMode()

Returns the rounding mode setting. This will be one of RoundingMode.CEILING, RoundingMode.DOWN, RoundingMode.FLOOR, RoundingMode.HALF_DOWN, RoundingMode.HALF_EVEN, RoundingMode.HALF_UP, RoundingMode.UNNECESSARY, or RoundingMode.UP.

Returns:

the rounding mode setting.

toString

public String toString()

Returns "precision=p roundingMode=MODE" where p is an int giving the precision and MODE is UP, DOWN, HALF_UP, HALF_DOWN, HALF_EVEN, CEILING, FLOOR, or UNNECESSARY corresponding to rounding modes.

Overrides:

toString in class Object

Returns:

a String describing this MathContext

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

hashCode

public int hashCode()

Returns the hashcode for this MathContext.

Overrides:

hashCode in class Object

Returns:

the hashcode for this MathContext.

See Also:

Object.equals(Object), System.identityHashCode(Object)