1 /*
2 * Copyright 2003-2004 The Apache Software Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.apache.commons.convert1.string;
17
18
19 import org.apache.commons.convert1.ConversionException;
20 import org.apache.commons.convert1.Converter;
21
22
23 /**
24 * <p>Standard {@link Converter} implementation that converts an incoming
25 * String into a <code>java.lang.String</code> object, optionally using a
26 * default value or throwing a {@link ConversionException} if a conversion
27 * error occurs.</p>
28 *
29 * @author Craig R. McClanahan
30 * @version $Id: StringConverter.java 155441 2005-02-26 13:19:22Z dirkv $
31 * @since 0.1
32 */
33
34 ///H/ This class is useless. It turns a String into a String,
35 ///H/ although the code itself doesn't know it's being given a String.
36 public final class StringConverter implements Converter {
37
38
39 // --------------------------------------------------------- Public Methods
40
41
42 /**
43 * Convert the specified input object into an output object of the
44 * specified type.
45 *
46 * @param type Data type to which this value should be converted
47 * @param value The input value to be converted
48 *
49 * @exception ConversionException if conversion cannot be performed
50 * successfully
51 */
52 public Object convert(Class type, Object value) {
53
54 if (value == null) {
55 return ((String) null);
56 } else {
57 return (value.toString());
58 }
59
60 }
61
62
63 }