RenderingHints.Key (Java 2 Platform SE 5.0) (original) (raw)

java.awt

Class RenderingHints.Key

java.lang.Object extended by java.awt.RenderingHints.Key

Enclosing class:

public abstract static class RenderingHints.Key

Defines the base 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.

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, finalize, getClass, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

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](../../java/lang/Object.html#hashCode%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a hash code value for this object.

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](../../java/lang/Object.html#equals%28java.lang.Object%29) in class [Object](../../java/lang/Object.html "class in java.lang")

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 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.