org.geotools.factory
Class Hints.OptionKey

Object
  extended by RenderingHints.Key
      extended by Hints.Key
          extended by Hints.OptionKey
Enclosing class:
Hints

public static final class Hints.OptionKey
extends Hints.Key

Key that allows the choice of several options. You can use "*" as a wild card to indicate that undocumented options may be supported (but there is no assurances - Hints.DATUM_SHIFT_METHOD).

Since:
2.4
Author:
Jody Garnett
Module:

Constructor Summary
Hints.OptionKey(String... alternatives)
          Creates a new key for a configuration option.
 
Method Summary
 Set<String> getOptions()
          Returns the set of available options.
 boolean isCompatibleValue(Object value)
          Returns true if the specified object is one of the valid options.
 
Methods inherited from class Hints.Key
getValueClass, toString
 
Methods inherited from class RenderingHints.Key
equals, hashCode, intKey
 
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Hints.OptionKey

public Hints.OptionKey(String... alternatives)
Creates a new key for a configuration option.

Parameters:
alternatives - The available options.
Method Detail

getOptions

public Set<String> getOptions()
Returns the set of available options.

Returns:
The available options.

isCompatibleValue

public boolean isCompatibleValue(Object value)
Returns true if the specified object is one of the valid options. If the options specified at construction time contains the "*" wildcard, then this method returns true for every String object.

Overrides:
isCompatibleValue in class Hints.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), isCompatibleValue(java.lang.Object)


Copyright © 1996-2009 Geotools. All Rights Reserved.