ParameterConverters.NumberConverter (JBehave Core 5.1-SNAPSHOT API)

java.lang.Object
- org.jbehave.core.steps.ParameterConverters.AbstractParameterConverter<String,T>
- - org.jbehave.core.steps.ParameterConverters.FromStringParameterConverter<Number>
  - - org.jbehave.core.steps.ParameterConverters.NumberConverter

All Implemented Interfaces:

ParameterConverters.ParameterConverter<String,Number>

Enclosing class:

ParameterConverters
```
public static class ParameterConverters.NumberConverter
extends ParameterConverters.FromStringParameterConverter<Number>
```
Converts values to numbers, supporting any subclass of Number (including generic Number type), and it unboxed counterpart, using a NumberFormat to parse to a Number and to convert it to a specific number type:
- Byte, byte: Number.byteValue()
- Short, short: Number.shortValue()
- Integer, int: Number.intValue()
- Float, float: Number.floatValue()
- Long, long: Number.longValue()
- Double, double: Number.doubleValue()
- BigInteger: BigInteger.valueOf(long)
- BigDecimal: BigDecimal.valueOf(double)
If no number format is provided, it defaults to NumberFormat.getInstance().
The localized instance NumberFormat.getInstance(Locale) can be used to convert numbers in specific locales.

Constructor Summary

Constructors
Constructor Description

NumberConverter()

NumberConverter(NumberFormat numberFormat)

Method Summary

Modifier and Type	Method	Description
`boolean`	`canConvertTo(Type type)`	Return `true` if the converter can convert to the desired target type.
`Number`	`convertValue(String value, Type type)`	Convert the value from one type to another, for example from a `boolean` to a `String`.

Methods inherited from class org.jbehave.core.steps.ParameterConverters.AbstractParameterConverter
canConvertFrom, getSourceType, getTargetType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NumberConverter
```
public NumberConverter()
```
  - NumberConverter
```
public NumberConverter(NumberFormat numberFormat)
```
- Method Detail
  - canConvertTo
```
public boolean canConvertTo(Type type)
```
    Description copied from interface: ParameterConverters.ParameterConverter
    
    Return true if the converter can convert to the desired target type.
    
    Specified by:
    
    canConvertTo in interface ParameterConverters.ParameterConverter<String,Number>
    
    Overrides:
    
    canConvertTo in class ParameterConverters.AbstractParameterConverter<String,Number>
    
    Parameters:
    
    type - the type descriptor that describes the requested result type
    
    Returns:
    
    true if that conversion can be performed
  - convertValue
```
public Number convertValue(String value,
                           Type type)
```
    Description copied from interface: ParameterConverters.ParameterConverter
    
    Convert the value from one type to another, for example from a boolean to a String.
    
    Parameters:
    
    value - the value to be converted
    
    type - the type descriptor that supplies extra information about the requested result type
    
    Returns:
    
    the converted value