001/* RoundingMode.java -- An Enum to replace BigDecimal rounding constants. 
002   Copyright (C) 1999, 2000, 2002, 2004, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.math;
040
041/**
042 * An enum to specify rounding behaviour for numerical operations that may
043 * discard precision.
044 * @author Anthony Balkissoon abalkiss at redhat dot com
045 *
046 */
047public enum RoundingMode
048{
049  UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN, HALF_EVEN, UNNECESSARY;
050
051  /**
052   * For compatability with Sun's JDK
053   */
054  private static final long serialVersionUID = 432302042773881265L;
055  
056  /**
057   * Returns the RoundingMode object corresponding to the legacy rounding modes
058   * in BigDecimal.
059   * @param rm the legacy rounding mode
060   * @return the corresponding RoundingMode
061   */
062  public static RoundingMode valueOf(int rm)
063  {
064    switch (rm)
065      {
066      case BigDecimal.ROUND_CEILING:
067        return CEILING;
068      case BigDecimal.ROUND_FLOOR:
069        return FLOOR;
070      case BigDecimal.ROUND_DOWN:
071        return DOWN;
072      case BigDecimal.ROUND_UP:
073        return UP;
074      case BigDecimal.ROUND_HALF_UP:
075        return HALF_UP;
076      case BigDecimal.ROUND_HALF_DOWN:
077        return HALF_DOWN;
078      case BigDecimal.ROUND_HALF_EVEN:
079        return HALF_EVEN;
080      case BigDecimal.ROUND_UNNECESSARY:
081        return UNNECESSARY;
082      default:
083        throw new 
084          IllegalArgumentException("invalid argument: " + rm + 
085                                   ".  Argument should be one of the " + 
086                                   "rounding modes defined in BigDecimal.");
087      }
088  }
089}