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.jxpath.util;
18
19 /**
20 * A type converter can be installed on {@link TypeUtils} to introduce
21 * additional type conversions for JXPath. Most of
22 * the time {@link BasicTypeConverter} should be used as the superclass.
23 *
24 * @see TypeUtils#setTypeConverter
25 *
26 * @author Dmitri Plotnikov
27 * @version $Revision: 652845 $ $Date: 2008-05-02 19:46:46 +0200 (Fr, 02 Mai 2008) $
28 */
29 public interface TypeConverter {
30
31 /**
32 * Returns true if it can convert the supplied
33 * object to the specified class.
34 * @param object object to test
35 * @param toType target class
36 * @return boolean
37 */
38 boolean canConvert(Object object, Class toType);
39
40 /**
41 * Converts the supplied object to the specified
42 * type. Throws a runtime exception if the conversion is
43 * not possible.
44 * @param object object to convert
45 * @param toType target class
46 * @return resulting Object
47 */
48 Object convert(Object object, Class toType);
49 }