java.math

Class MathContext

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

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

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

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, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DECIMAL128

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

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.

UNLIMITED

public static final MathContext UNLIMITED
A MathContext for unlimited precision arithmetic *

Constructor Details

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 <320.

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 <320.

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 <320.

Method Details

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 interface Object
Returns:
true if the above conditions hold

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.

hashCode

public int hashCode()
Returns the hashcode for this MathContext.
Overrides:
hashCode in interface Object
Returns:
the hashcode for this MathContext.

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 interface Object
Returns:
a String describing this MathContext

MathContext.java -- Copyright (C) 1999, 2000, 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.