com.vaadin.data.util.converter.StringToBooleanConverter Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.data.util.converter;
import java.util.Locale;
/**
* A converter that converts from {@link String} to {@link Boolean} and back.
* The String representation is given by {@link Boolean#toString()} or provided
* in constructor {@link #StringToBooleanConverter(String, String)}.
*
* Leading and trailing white spaces are ignored when converting from a String.
*
*
* For language-dependent representation, subclasses should overwrite
* {@link #getFalseString(Locale)} and {@link #getTrueString(Locale)}
*
*
* @author Vaadin Ltd
* @since 7.0
*/
public class StringToBooleanConverter implements Converter {
private final String trueString;
private final String falseString;
/**
* Creates converter with default string representations - "true" and
* "false"
*
*/
public StringToBooleanConverter() {
this(Boolean.TRUE.toString(), Boolean.FALSE.toString());
}
/**
* Creates converter with custom string representation.
*
* @since 7.5.4
* @param falseString
* string representation for false
* @param trueString
* string representation for true
*/
public StringToBooleanConverter(String trueString, String falseString) {
this.trueString = trueString;
this.falseString = falseString;
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,
* java.lang.Class, java.util.Locale)
*/
@Override
public Boolean convertToModel(String value,
Class targetType, Locale locale)
throws ConversionException {
if (value == null || value.isEmpty()) {
return null;
}
// Remove leading and trailing white space
value = value.trim();
if (getTrueString().equals(value)) {
return true;
} else if (getFalseString().equals(value)) {
return false;
} else {
throw new ConversionException("Cannot convert " + value + " to "
+ getModelType().getName());
}
}
/**
* Gets the string representation for true. Default is "true", if not set in
* constructor.
*
* @return the string representation for true
*/
protected String getTrueString() {
return trueString;
}
/**
* Gets the string representation for false. Default is "false", if not set
* in constructor.
*
* @return the string representation for false
*/
protected String getFalseString() {
return falseString;
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
* .Object, java.lang.Class, java.util.Locale)
*/
@Override
public String convertToPresentation(Boolean value,
Class targetType, Locale locale)
throws ConversionException {
if (value == null) {
return null;
}
if (value) {
return getTrueString(locale);
} else {
return getFalseString(locale);
}
}
/**
* Gets the locale-depended string representation for false. Default is
* locale-independent value provided by {@link #getFalseString()}
*
* @since 7.5.4
* @param locale
* to be used
* @return the string representation for false
*/
protected String getFalseString(Locale locale) {
return getFalseString();
}
/**
* Gets the locale-depended string representation for true. Default is
* locale-independent value provided by {@link #getTrueString()}
*
* @since 7.5.4
* @param locale
* to be used
* @return the string representation for true
*/
protected String getTrueString(Locale locale) {
return getTrueString();
}
/*
* (non-Javadoc)
*
* @see com.vaadin.data.util.converter.Converter#getModelType()
*/
@Override
public Class getModelType() {
return Boolean.class;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.data.util.converter.Converter#getPresentationType()
*/
@Override
public Class getPresentationType() {
return String.class;
}
}