com.vaadin.data.util.converter
Class StringToBooleanConverter

java.lang.Object
  com.vaadin.data.util.converter.StringToBooleanConverter

All Implemented Interfaces:

Converter<String,Boolean>, Serializable

public class StringToBooleanConverter
extends Object
implements Converter<String,Boolean>

A converter that converts from String to Boolean and back. The String representation is given by Boolean.toString().

Leading and trailing white spaces are ignored when converting from a String.

Since:

7.0

Version:

7.0.0.alpha3

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.util.converter.Converter

Converter.ConversionException

Constructor Summary

StringToBooleanConverter()

Method Summary

Boolean	convertToModel(String value, Locale locale) Converts the given value from target type to source type.
String	convertToPresentation(Boolean value, Locale locale) Converts the given value from source type to target type.
protected String	getFalseString() Gets the string representation for false.
Class<Boolean>	getModelType() The source type of the converter.
Class<String>	getPresentationType() The target type of the converter.
protected String	getTrueString() Gets the string representation for true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringToBooleanConverter

public StringToBooleanConverter()

Method Detail

convertToModel

public Boolean convertToModel(String value,
                              Locale locale)
                       throws Converter.ConversionException

Description copied from interface: Converter

Converts the given value from target type to source type.

A converter can optionally use locale to do the conversion.

A converter should in most cases be symmetric so chaining Converter.convertToPresentation(Object, Locale) and Converter.convertToModel(Object, Locale) should return the original value.

Specified by:

convertToModel in interface Converter<String,Boolean>

Parameters:

value - The value to convert, compatible with the target type. Can be null

locale - The locale to use for conversion. Can be null.

Returns:

The converted value compatible with the source type

Throws:

Converter.ConversionException - If the value could not be converted

getTrueString

protected String getTrueString()

Gets the string representation for true. Default is "true".

Returns:

the string representation for true

getFalseString

protected String getFalseString()

Gets the string representation for false. Default is "false".

Returns:

the string representation for false

convertToPresentation

public String convertToPresentation(Boolean value,
                                    Locale locale)
                             throws Converter.ConversionException

Description copied from interface: Converter

Converts the given value from source type to target type.

A converter can optionally use locale to do the conversion.

A converter should in most cases be symmetric so chaining Converter.convertToPresentation(Object, Locale) and Converter.convertToModel(Object, Locale) should return the original value.

Specified by:

convertToPresentation in interface Converter<String,Boolean>

Parameters:

value - The value to convert, compatible with the target type. Can be null

locale - The locale to use for conversion. Can be null.

Returns:

The converted value compatible with the source type

Throws:

Converter.ConversionException - If the value could not be converted

getModelType

public Class<Boolean> getModelType()

Description copied from interface: Converter

The source type of the converter. Values of this type can be passed to Converter.convertToPresentation(Object, Locale).

Specified by:

getModelType in interface Converter<String,Boolean>

Returns:

The source type

getPresentationType

public Class<String> getPresentationType()

Description copied from interface: Converter

The target type of the converter. Values of this type can be passed to Converter.convertToModel(Object, Locale).

Specified by:

getPresentationType in interface Converter<String,Boolean>

Returns:

The target type