View Javadoc

1   package org.apache.commons.ognl;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.lang.reflect.Member;
23  import java.util.Map;
24  
25  /**
26   * Interface for accessing the type conversion facilities within a context.
27   *
28   * @author Luke Blanshard (blanshlu@netscape.net)
29   * @author Drew Davidson (drew@ognl.org)
30   */
31  public interface TypeConverter
32  {
33  
34      /**
35       * Converts the given value to a given type. The OGNL context, target, member and name of property being set are
36       * given. This method should be able to handle conversion in general without any context, target, member or property
37       * name specified.
38       *
39       * @param context      OGNL context under which the conversion is being done
40       * @param target       target object in which the property is being set
41       * @param member       member (Constructor, Method or Field) being set
42       * @param propertyName property name being set
43       * @param value        value to be converted
44       * @param toType       type to which value is converted
45       * @return Converted value of type toType or TypeConverter.NoConversionPossible to indicate that the conversion was
46       *         not possible.
47       */
48      <T> T convertValue( Map<String, Object> context, Object target, Member member, String propertyName, Object value,
49                          Class<T> toType );
50  
51  }