org.geotools.factory
Class Hints.Key

java.lang.Object
  java.awt.RenderingHints.Key
      org.geotools.factory.Hints.Key

Enclosing class:

Hints

public static final 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 17696 2006-01-22 07:33:19Z desruisseaux $

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 if the specified object is a valid value for 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, toString, 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.

isCompatibleValue

public boolean isCompatibleValue(java.lang.Object value)

Returns if the specified object is a valid value for this key. This method checks if the specified value is non-null and is one of the following:

• An instance of the expected value class.
• A Class assignable to the expected value class.
• An array of objects assignable to the expected value class.

Parameters:

value - The object to test for validity.

Returns:

if the value is valid; otherwise.