java.awt

## Class RenderingHints.Key

- java.lang.Object
- - java.awt.RenderingHints.Key

- Enclosing class:
    RenderingHints

      public abstract static class RenderingHints.Key
      extends Object

  Defines the base type of all keys used along with the `RenderingHints` class to control various algorithm choices in 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.

- - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `RenderingHints.Key(int privatekey)` Construct a key using the indicated private key.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object o)` The equals method for all Key objects will return the same result as the equality operator '=='.
    `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.
    `protected 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.

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### RenderingHints.Key

          protected RenderingHints.Key(int privatekey)

      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.
      Parameters:
        `privatekey` - the specified key

  - ### Method Detail

    - #### isCompatibleValue

          public abstract 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.

    - #### intKey

          protected final int intKey()

      Returns the private integer key that the subclass instantiated this Key with.
      Returns:
        the private integer key that the subclass instantiated this Key with.

    - #### hashCode

          public 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.
      Overrides:
        `hashCode` in class `Object`
      Returns:
        a hash code value for this object.
      See Also:
        `Object.equals(java.lang.Object)`, `Hashtable`

    - #### equals

          public final boolean equals(Object o)

      The equals method for all Key objects will return the same result as the equality operator '=='.
      Overrides:
        `equals` in class `Object`
      Parameters:
        `o` - the reference object with which to compare.
      Returns:
        `true` if this object is the same as the obj argument; `false` otherwise.
      See Also:
        `Object.hashCode()`, `Hashtable`

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.