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