Hints.DoubleKey (Geotools modules 31-SNAPSHOT API)

Object
- RenderingHints.Key
- - Hints.Key
  - - DoubleKey

Enclosing class:

Hints
```
public static final class Hints.DoubleKey
extends Hints.Key
```
A hint used to capture a configuration setting as double. A default value is provided and may be checked with getDefault().

Since:

2.6

Author:

Jody Garnett

Constructor Summary

Constructors
Constructor Description

DoubleKey(double number)
Creates a new key with the specified default value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getDefault()`	Returns the default value.
`boolean`	`isCompatibleValue(Object value)`	Returns `true` if the specified object is a valid integer.
`double`	`toValue(Hints hints)`	Returns the value from the specified hints as a double.

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
  - DoubleKey
```
public DoubleKey(double number)
```
    Creates a new key with the specified default value.
    
    Parameters:
    
    number - The default value.
- Method Detail
  - getDefault
```
public double getDefault()
```
    Returns the default value.
    
    Returns:
    
    The default value.
  - toValue
```
public double toValue(Hints hints)
```
    Returns the value from the specified hints as a double. If no value were found for this key, then this method returns the default value.
    
    Parameters:
    
    hints - The map where to fetch the hint value, or null.
    
    Returns:
    
    The hint value as a double, or the default value if not hint was explicitly set.
  - isCompatibleValue
```
public boolean isCompatibleValue(Object value)
```
    Returns true if the specified object is a valid integer.
    
    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), Hints.OptionKey.isCompatibleValue(java.lang.Object)