1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.beanutils.converters;
18
19
20 /**
21 * {@link org.apache.commons.beanutils.Converter} implementaion that handles conversion
22 * to and from <b>java.lang.Character</b> objects.
23 * <p>
24 * Can be configured to either return a <i>default value</i> or throw a
25 * <code>ConversionException</code> if a conversion error occurs.
26 *
27 * @version $Id$
28 * @since 1.3
29 */
30 public final class CharacterConverter extends AbstractConverter {
31
32 /**
33 * Construct a <b>java.lang.Character</b> <i>Converter</i> that throws
34 * a <code>ConversionException</code> if an error occurs.
35 */
36 public CharacterConverter() {
37 super();
38 }
39
40 /**
41 * Construct a <b>java.lang.Character</b> <i>Converter</i> that returns
42 * a default value if an error occurs.
43 *
44 * @param defaultValue The default value to be returned
45 * if the value to be converted is missing or an error
46 * occurs converting the value.
47 */
48 public CharacterConverter(final Object defaultValue) {
49 super(defaultValue);
50 }
51
52 /**
53 * Return the default type this <code>Converter</code> handles.
54 *
55 * @return The default type this <code>Converter</code> handles.
56 * @since 1.8.0
57 */
58 @Override
59 protected Class<?> getDefaultType() {
60 return Character.class;
61 }
62
63 /**
64 * <p>Convert a java.lang.Class or object into a String.</p>
65 *
66 * @param value The input value to be converted
67 * @return the converted String value.
68 * @since 1.8.0
69 */
70 @Override
71 protected String convertToString(final Object value) {
72 final String strValue = value.toString();
73 return strValue.length() == 0 ? "" : strValue.substring(0, 1);
74 }
75
76 /**
77 * <p>Convert the input object into a java.lang.Character.</p>
78 *
79 * @param <T> Target type of the conversion.
80 * @param type Data type to which this value should be converted.
81 * @param value The input value to be converted.
82 * @return The converted value.
83 * @throws Exception if conversion cannot be performed successfully
84 * @since 1.8.0
85 */
86 @Override
87 protected <T> T convertToType(final Class<T> type, final Object value) throws Exception {
88 if (Character.class.equals(type) || Character.TYPE.equals(type)) {
89 return type.cast(new Character(value.toString().charAt(0)));
90 }
91
92 throw conversionException(type, value);
93 }
94
95 }