Known Direct Subclasses
  
 | 
Class Overview
Defines the type of all keys used to control various
 aspects of the rendering and imaging pipelines.  Instances
 of this class are immutable and unique which means that
 tests for matches can be made using the == operator instead
 of the more expensive equals() method.
 
Summary
| Public Constructors | 
	 
    
        | 
            
            
            
            
            
            
         | 
        
        SunHints.Key(int privatekey, String description)
        
         Construct a key using the indicated private key. 
  
   | 
| Public Methods | 
	 
    
        | 
            
            
            final
            
            
            int
         | 
        
        getIndex()
        
         Returns the numeric index associated with this Key. 
  
   | 
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        isCompatibleValue(Object val)
        
         Returns true if the specified object is a valid value
 for this Key. 
  
   | 
	 
    
        | 
            
            
            final
            
            
            String
         | 
        
        toString()
        
         Returns a string representation of the Key. 
  
   | 
| 
  [Expand]
   Inherited Methods  | 
   
From class
  java.awt.RenderingHints.Key
  
   
  
    
    
	 
    
        | 
            
            
            final
            
            
            boolean
         | 
        
        equals(Object o)
        
         The equals method for all Key objects will return the same
 result as the equality operator '=='. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            int
         | 
        
        hashCode()
        
         The hash code for all Key objects will be the same as the
 system identity code of the object as defined by the
 System.identityHashCode() method. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            int
         | 
        
        intKey()
        
         Returns the private integer key that the subclass
 instantiated this Key with. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        isCompatibleValue(Object val)
        
         Returns true if the specified object is a valid value
 for this Key. 
  
   |  
 
   
 
 | 
   
From class
  java.lang.Object
  
   
  
    
    
	 
    
        | 
            
            
            
            
            
            Object
         | 
        
        clone()
        
         Creates and returns a copy of this object. 
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        equals(Object obj)
        
         Indicates whether some other object is "equal to" this one. 
  
   |  
	 
    
        | 
            
            
            
            
            
            void
         | 
        
        finalize()
        
         Called by the garbage collector on an object when garbage collection
 determines that there are no more references to the object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            Class<?>
         | 
        
        getClass()
        
         Returns the runtime class of this Object. 
  
   |  
	 
    
        | 
            
            
            
            
            
            int
         | 
        
        hashCode()
        
         Returns a hash code value for the object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        notify()
        
         Wakes up a single thread that is waiting on this object's
 monitor. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        notifyAll()
        
         Wakes up all threads that are waiting on this object's monitor. 
  
   |  
	 
    
        | 
            
            
            
            
            
            String
         | 
        
        toString()
        
         Returns a string representation of the object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait()
        
        Causes the current thread to wait until another thread invokes the
  notify() method or the
  notifyAll() method for this object.  
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait(long timeout, int nanos)
        
        Causes the current thread to wait until another thread invokes the
  notify() method or the
  notifyAll() method for this object, or
 some other thread interrupts the current thread, or a certain
 amount of real time has elapsed.  
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait(long timeout)
        
        Causes the current thread to wait until either another thread invokes the
  notify() method or the
  notifyAll() method for this object, or a
 specified amount of time has elapsed.  
  
   |  
 
   
 
 | 
 
Public Constructors
 
    
      
        public 
         
         
         
         
        
      
      SunHints.Key
      (int privatekey, String description)
    
      
    
      
  Construct a key using the indicated private key.  Each
 subclass of Key maintains its own unique domain of integer
 keys.  No two objects with the same integer key and of the
 same specific subclass can be constructed.  An exception
 will be thrown if an attempt is made to construct another
 object of a given class with the same integer key as a
 pre-existing instance of that subclass of Key.
 
     
 
Public Methods
 
    
      
        public 
         
        final 
         
         
        int
      
      getIndex
      ()
    
      
    
      
  Returns the numeric index associated with this Key.  This
 is useful for use in switch statements and quick lookups
 of the setting of a particular key.
 
     
 
 
    
      
        public 
         
         
         
         
        boolean
      
      isCompatibleValue
      (Object val)
    
      
    
      
  Returns true if the specified object is a valid value
 for this Key.
 
  
      Parameters
      
        
          | val
           | the Object to test for validity | 
        
      
   
  
      Returns
      true if val is valid;
         false otherwise.
   
     
 
 
    
      
        public 
         
        final 
         
         
        String
      
      toString
      ()
    
      
    
      
  Returns a string representation of the Key.
 
  
      Returns
      - a string representation of the object.