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.dbutils;
18
19 /**
20 * Defines how to handle properties when constructing a bean from a {@link java.sql.ResultSet}. Instances coerce values into a target types.
21 */
22 public interface PropertyHandler {
23
24 /**
25 * Stores the given {@code value} into an instance of type {@code parameter}. This method is only called if {@link #match(Class, Object)} return true.
26 *
27 * @param parameter The type of the target parameter.
28 * @param value The value to set.
29 * @return The converted value or the original value if something doesn't work out.
30 */
31 Object apply(Class<?> parameter, Object value);
32
33 /**
34 * Tests whether to handle setting {@code value} into an instance of {@code parameter}.
35 *
36 * @param parameter The type of the target parameter.
37 * @param value The value to be set.
38 * @return true is this property handler can/wants to handle this value; false otherwise.
39 */
40 boolean match(Class<?> parameter, Object value);
41 }