org.omnifaces.converter.TrimConverter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of omnifaces Show documentation
Show all versions of omnifaces Show documentation
Jakarta Faces 3.0+ utility library
/*
* Copyright OmniFaces
*
* 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
*
* https://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 org.omnifaces.converter;
import static org.omnifaces.util.Utils.coalesce;
import static org.omnifaces.util.Utils.isEmpty;
import jakarta.faces.component.UIComponent;
import jakarta.faces.context.FacesContext;
import jakarta.faces.convert.Converter;
import jakarta.faces.convert.FacesConverter;
/**
*
* The omnifaces.TrimConverter
is intented to trim any whitespace from submitted {@link String} values.
* This keeps the data store free of whitespace pollution.
*
* This converter does by design no conversion in getAsString()
.
*
*
Usage
*
* This converter is available by converter ID omnifaces.TrimConverter
. Just specify it in the
* converter
attribute of the component referring the String
property. For example:
*
* <h:inputText value="#{bean.username}" converter="omnifaces.TrimConverter" />
*
*
* You can also configure it application wide via below entry in faces-config.xml
without the need to
* specify it in every single input component:
*
* <converter>
* <converter-for-class>java.lang.String</converter-for-class>
* <converter-class>org.omnifaces.converter.TrimConverter</converter-class>
* </converter>
*
*
* @author Bauke Scholtz
* @since 2.6
*/
@FacesConverter("omnifaces.TrimConverter")
public class TrimConverter implements Converter {
@Override
public String getAsObject(FacesContext context, UIComponent component, String submittedValue) {
if (isEmpty(submittedValue)) {
return null;
}
String trimmed = submittedValue.trim();
return isEmpty(trimmed) ? null : trimmed;
}
@Override
public String getAsString(FacesContext context, UIComponent component, String modelValue) {
return coalesce(modelValue, "");
}
}