org.geotools.factory
Class Hints.Key

java.lang.Object
  extended by java.awt.RenderingHints.Key
      extended by org.geotools.factory.Hints.Key
Direct Known Subclasses:
Hints.ClassKey, Hints.DoubleKey, Hints.FileKey, Hints.IntegerKey, Hints.OptionKey
Enclosing class:
Hints

public static class Hints.Key
extends java.awt.RenderingHints.Key

The type for keys used to control various aspects of the factory creation. Factory creation impacts rendering (which is why extending rendering key is not a complete non-sense), but may impact other aspects of an application as well.

Since:
2.1
Version:
$Id: Hints.java 35735 2010-06-19 15:17:07Z aaime $
Author:
Martin Desruisseaux

Constructor Summary
Hints.Key(java.lang.Class<?> classe)
          Constructs a new key for values of the given class.
 
Method Summary
 java.lang.Class<?> getValueClass()
          Returns the expected class for values stored under this key.
 boolean isCompatibleValue(java.lang.Object value)
          Returns true if the specified object is a valid value for this key.
 java.lang.String toString()
          Returns a string representation of this key.
 
Methods inherited from class java.awt.RenderingHints.Key
equals, hashCode, intKey
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Hints.Key

public Hints.Key(java.lang.Class<?> classe)
Constructs a new key for values of the given class.

Parameters:
classe - The base class for all valid values.
Method Detail

getValueClass

public java.lang.Class<?> getValueClass()
Returns the expected class for values stored under this key.

Returns:
The class of values stored under this key.

isCompatibleValue

public boolean isCompatibleValue(java.lang.Object value)
Returns true if the specified object is a valid value for this key. The default implementation checks if the specified value is an instance of the value class.

Note that many hint keys defined in the Hints class relax this rule and accept Class object assignable to the expected value class as well.

Specified by:
isCompatibleValue in class java.awt.RenderingHints.Key
Parameters:
value - The object to test for validity.
Returns:
true if the value is valid; false otherwise.
See Also:
Hints.ClassKey.isCompatibleValue(java.lang.Object), Hints.FileKey.isCompatibleValue(java.lang.Object), Hints.IntegerKey.isCompatibleValue(java.lang.Object), Hints.OptionKey.isCompatibleValue(java.lang.Object)

toString

public java.lang.String toString()
Returns a string representation of this key. The string representation is mostly for debugging purpose. The default implementation tries to infer the key name using reflection.

Overrides:
toString in class java.lang.Object


Copyright © 1996-2010 Geotools. All Rights Reserved.