com.vaadin.data.util.converter.StringToBooleanConverter Maven / Gradle / Ivy
/*
* Copyright 2000-2014 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the 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 Boolean.toString().
*
* Leading and trailing white spaces are ignored when converting from a String.
*
*
* @author Vaadin Ltd
* @since 7.0
*/
public class StringToBooleanConverter implements Converter {
/*
* (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 extends Boolean> 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".
*
* @return the string representation for true
*/
protected String getTrueString() {
return Boolean.TRUE.toString();
}
/**
* Gets the string representation for false. Default is "false".
*
* @return the string representation for false
*/
protected String getFalseString() {
return Boolean.FALSE.toString();
}
/*
* (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 extends String> targetType, Locale locale)
throws ConversionException {
if (value == null) {
return null;
}
if (value) {
return getTrueString();
} else {
return getFalseString();
}
}
/*
* (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;
}
}