Class Overview
Specifies the rounding behavior for operations whose results cannot be
 represented exactly.
 
Summary
| Enum Values | 
    
    
        | RoundingMode  | 
        CEILING  | 
        Rounding mode to round towards positive infinity.  | 
    
    
    
    
        | RoundingMode  | 
        DOWN  | 
        Rounding mode where the values are rounded towards zero.  | 
    
    
    
    
        | RoundingMode  | 
        FLOOR  | 
        Rounding mode to round towards negative infinity.  | 
    
    
    
    
        | RoundingMode  | 
        HALF_DOWN  | 
        Rounding mode where values are rounded towards the nearest neighbor.  | 
    
    
    
    
        | RoundingMode  | 
        HALF_EVEN  | 
        Rounding mode where values are rounded towards the nearest neighbor.  | 
    
    
    
    
        | RoundingMode  | 
        HALF_UP  | 
        Rounding mode where values are rounded towards the nearest neighbor.  | 
    
    
    
    
        | RoundingMode  | 
        UNNECESSARY  | 
        Rounding mode where the rounding operations throws an ArithmeticException
 for the case that rounding is necessary, i.e.  | 
    
    
    
    
        | RoundingMode  | 
        UP  | 
        Rounding mode where positive values are rounded towards positive infinity
 and negative values towards negative infinity.  | 
    
    
    
| 
  [Expand]
   Inherited Methods  | 
   
From class
  java.lang.Enum
  
   
  
    
    
	 
    
        | 
            
            
            final
            
            
            Object
         | 
        
        clone()
        
         Enum objects are singletons, they may not be cloned. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            int
         | 
        
        compareTo(E o)
        
         Compares this object to the specified enum object to determine their
 relative order. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            boolean
         | 
        
        equals(Object other)
        
         Compares this object with the specified object and indicates if they are
 equal. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        finalize()
        
         Enum types may not have finalizers. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            Class<E>
         | 
        
        getDeclaringClass()
        
         Returns the enum constant's declaring class. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            int
         | 
        
        hashCode()
        
         Returns an integer hash code for this object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            String
         | 
        
        name()
        
         Returns the name of this enum constant. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            int
         | 
        
        ordinal()
        
         Returns the position of the enum constant in the declaration. 
  
   |  
	 
    
        | 
            
            
            
            
            
            String
         | 
        
        toString()
        
         Returns a string containing a concise, human-readable description of this
 object. 
  
   |  
	 
    
        | 
            
            
            
            static
            <T extends Enum<T>>
            T
         | 
        
        valueOf(Class<T> enumType, String name)
        
         Returns the constant with the specified name of the specified enum type. 
  
   |  
 
   
 
 | 
   
From class
  java.lang.Object
  
   
  
    
    
	 
    
        | 
            
            
            
            
            
            Object
         | 
        
        clone()
        
         Creates and returns a copy of this Object. 
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        equals(Object o)
        
         Compares this instance with the specified object and indicates if they
 are equal. 
  
   |  
	 
    
        | 
            
            
            
            
            
            void
         | 
        
        finalize()
        
         Invoked when the garbage collector has detected that this instance is no longer reachable. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            Class<?>
         | 
        
        getClass()
        
        Returns the unique instance of  Class that represents this
 object's class.  
  
   |  
	 
    
        | 
            
            
            
            
            
            int
         | 
        
        hashCode()
        
         Returns an integer hash code for this object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        notify()
        
         Causes a thread which is waiting on this object's monitor (by means of
 calling one of the wait() methods) to be woken up. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        notifyAll()
        
         Causes all threads which are waiting on this object's monitor (by means
 of calling one of the wait() methods) to be woken up. 
  
   |  
	 
    
        | 
            
            
            
            
            
            String
         | 
        
        toString()
        
         Returns a string containing a concise, human-readable description of this
 object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait()
        
         Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait(long millis, int nanos)
        
         Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
 specified timeout expires. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait(long millis)
        
         Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
 specified timeout expires. 
  
   |  
 
   
 
 | 
   
From interface
  java.lang.Comparable
  
   
  
    
    
	 
    
        | 
            abstract
            
            
            
            
            int
         | 
        
        compareTo(T another)
        
         Compares this object to the specified object to determine their relative
 order. 
  
   |  
 
   
 
 | 
Enum Values
 
    
      
        public 
        static 
        final 
        RoundingMode
      
        CEILING
    
      
    
      
  Rounding mode to round towards positive infinity. For positive values
 this rounding mode behaves as UP, for negative values as
 DOWN.
 
 Rule: x.round() >= x
 
    
     
 
 
    
      
        public 
        static 
        final 
        RoundingMode
      
        DOWN
    
      
    
      
  Rounding mode where the values are rounded towards zero.
 
 Rule: x.round().abs() <= x.abs()
 
    
     
 
 
    
      
        public 
        static 
        final 
        RoundingMode
      
        FLOOR
    
      
    
      
  Rounding mode to round towards negative infinity. For positive values
 this rounding mode behaves as DOWN, for negative values as
 UP.
 
 Rule: x.round() <= x
 
    
     
 
 
    
      
        public 
        static 
        final 
        RoundingMode
      
        HALF_DOWN
    
      
    
      
  Rounding mode where values are rounded towards the nearest neighbor. Ties
 are broken by rounding down.
 
    
     
 
 
    
      
        public 
        static 
        final 
        RoundingMode
      
        HALF_EVEN
    
      
    
      
  Rounding mode where values are rounded towards the nearest neighbor. Ties
 are broken by rounding to the even neighbor.
 
    
     
 
 
    
      
        public 
        static 
        final 
        RoundingMode
      
        HALF_UP
    
      
    
      
  Rounding mode where values are rounded towards the nearest neighbor. Ties
 are broken by rounding up.
 
    
     
 
 
    
      
        public 
        static 
        final 
        RoundingMode
      
        UNNECESSARY
    
      
    
      
  Rounding mode where the rounding operations throws an ArithmeticException
 for the case that rounding is necessary, i.e. for the case that the value
 cannot be represented exactly.
 
    
     
 
 
    
      
    
      
  Rounding mode where positive values are rounded towards positive infinity
 and negative values towards negative infinity.
 
 Rule: x.round().abs() >= x.abs()
 
    
     
 
Public Methods
 
    
      
        public 
        static 
         
         
         
        RoundingMode
      
      valueOf
      (int mode)
    
      
    
      
  Converts rounding mode constants from class BigDecimal into
 RoundingMode values.
 
  
      Parameters
      
        
          | mode
           | rounding mode constant as defined in class BigDecimal | 
        
      
   
  
      Returns
      - corresponding rounding mode object