RenderingHints.Key (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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 {@link 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 {@code ==} operator instead of the more expensive {@code equals()} method.

Constructor Summary
`protected`	`RenderingHints.Key(int privatekey)` Construct a key using the indicated private key.

Method Summary
`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, equals, finalize, getClass, hashCode, 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

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

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

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.

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.