org.apache.commons.beanutils.converters.CharacterConverter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.commons.beanutils.converters;
/**
* {@link org.apache.commons.beanutils.Converter} implementaion that handles conversion
* to and from java.lang.Character objects.
*
* Can be configured to either return a default value or throw a
* ConversionException if a conversion error occurs.
*
* @version $Id: CharacterConverter.java 1540518 2013-11-10 19:04:04Z oheger $
* @since 1.3
*/
public final class CharacterConverter extends AbstractConverter {
/**
* Construct a java.lang.Character Converter that throws
* a ConversionException if an error occurs.
*/
public CharacterConverter() {
super();
}
/**
* Construct a java.lang.Character Converter that returns
* a default value if an error occurs.
*
* @param defaultValue The default value to be returned
* if the value to be converted is missing or an error
* occurs converting the value.
*/
public CharacterConverter(Object defaultValue) {
super(defaultValue);
}
/**
* Return the default type this Converter handles.
*
* @return The default type this Converter handles.
* @since 1.8.0
*/
@Override
protected Class getDefaultType() {
return Character.class;
}
/**
*
Convert a java.lang.Class or object into a String.
*
* @param value The input value to be converted
* @return the converted String value.
* @since 1.8.0
*/
@Override
protected String convertToString(Object value) {
String strValue = value.toString();
return strValue.length() == 0 ? "" : strValue.substring(0, 1);
}
/**
* Convert the input object into a java.lang.Character.
*
* @param Target type of the conversion.
* @param type Data type to which this value should be converted.
* @param value The input value to be converted.
* @return The converted value.
* @throws Exception if conversion cannot be performed successfully
* @since 1.8.0
*/
@Override
protected T convertToType(Class type, Object value) throws Exception {
if (Character.class.equals(type) || Character.TYPE.equals(type)) {
return type.cast(new Character(value.toString().charAt(0)));
}
throw conversionException(type, value);
}
}