We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.data.util.converter.
Class StringToBooleanConverter
- java.lang.Object
-
- com.vaadin.data.util.converter.StringToBooleanConverter
-
All Implemented Interfaces:
public class StringToBooleanConverter extends Object implements Converter<String,Boolean>A converter that converts from
StringtoBooleanand back. The String representation is given byBoolean.toString()or provided in constructorStringToBooleanConverter(String, String).Leading and trailing white spaces are ignored when converting from a String.
For language-dependent representation, subclasses should overwrite
getFalseString(Locale)andgetTrueString(Locale)Since:
7.0
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.data.util.converter.Converter
Converter.ConversionException
-
-
Constructor Summary
Constructors Constructor and Description StringToBooleanConverter()Creates converter with default string representations - "true" and "false"
StringToBooleanConverter(String trueString, String falseString)Creates converter with custom string representation.
-
Method Summary
All Methods Modifier and Type Method and Description BooleanconvertToModel(String value, Class<? extends Boolean> targetType, Locale locale)Converts the given value from target type to source type.
StringconvertToPresentation(Boolean value, Class<? extends String> targetType, Locale locale)Converts the given value from source type to target type.
protected StringgetFalseString()Gets the string representation for false.
protected StringgetFalseString(Locale locale)Gets the locale-depended string representation for false.
Class<Boolean>getModelType()The source type of the converter.
Class<String>getPresentationType()The target type of the converter.
protected StringgetTrueString()Gets the string representation for true.
protected StringgetTrueString(Locale locale)Gets the locale-depended string representation for true.
-
-
-
Constructor Detail
-
StringToBooleanConverter
public StringToBooleanConverter()Creates converter with default string representations - "true" and "false"
-
-
Method Detail
-
convertToModel
public Boolean convertToModel(String value, Class<? extends Boolean> targetType, Locale locale) throws Converter.ConversionExceptionDescription copied from interface:
ConverterConverts 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 chainingConverter.convertToPresentation(Object, Class, Locale)andConverter.convertToModel(Object, Class, Locale)should return the original value.Specified by:
convertToModelin interfaceConverter<String,Boolean>Parameters:
value- The value to convert, compatible with the target type. Can be nulltargetType- The requested type of the return valuelocale- 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", if not set in constructor.
Returns:
the string representation for true
-
getFalseString
protected String getFalseString()Gets the string representation for false. Default is "false", if not set in constructor.
Returns:
the string representation for false
-
convertToPresentation
public String convertToPresentation(Boolean value, Class<? extends String> targetType, Locale locale) throws Converter.ConversionExceptionDescription copied from interface:
ConverterConverts 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 chainingConverter.convertToPresentation(Object, Class, Locale)andConverter.convertToModel(Object, Class, Locale)should return the original value.Specified by:
convertToPresentationin interfaceConverter<String,Boolean>Parameters:
value- The value to convert, compatible with the target type. Can be nulltargetType- The requested type of the return valuelocale- 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
-
getFalseString
protected String getFalseString(Locale locale)Gets the locale-depended string representation for false. Default is locale-independent value provided by
getFalseString()Parameters:
locale- to be usedReturns:
the string representation for false
Since:
7.5.4
-
getTrueString
protected String getTrueString(Locale locale)Gets the locale-depended string representation for true. Default is locale-independent value provided by
getTrueString()Parameters:
locale- to be usedReturns:
the string representation for true
Since:
7.5.4
-
getModelType
public Class<Boolean> getModelType()Description copied from interface:
ConverterThe source type of the converter. Values of this type can be passed to
Converter.convertToPresentation(Object, Class, Locale).Specified by:
getModelTypein interfaceConverter<String,Boolean>Returns:
The source type
-
getPresentationType
public Class<String> getPresentationType()Description copied from interface:
ConverterThe target type of the converter. Values of this type can be passed to
Converter.convertToModel(Object, Class, Locale).Specified by:
getPresentationTypein interfaceConverter<String,Boolean>Returns:
The target type
-
-