org.dbflute.dbmeta.property.PropertyMethodFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation

The runtime library of DBFlute

There is a newer version: 1.2.8

/*
 * Copyright 2014-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.dbflute.dbmeta.property;

import java.lang.reflect.Method;

/**
 * The interface of finder for property method.
 * @author jflute
 * @since 1.0.5G (2014/05/20 Tuesday)
 */
public interface PropertyMethodFinder {

    /**
     * Find the read method for the property.
     * @param beanType The type of bean that declares the method. (NotNull)
     * @param propertyName The name of property to find the method. (NotNull)
     * @param propertyType The type of property. (NotNull)
     * @return The found method. (NullAllowed: when not found)
     */
    Method findReadMethod(Class beanType, String propertyName, Class propertyType);

    /**
     * Find the write method for the property.
     * @param beanType The type of bean that declares the method. (NotNull)
     * @param propertyName The name of property to find the method. (NotNull)
     * @param propertyType The type of property. (NotNull)
     * @return The found method. (NullAllowed: when not found)
     */
    Method findWriteMethod(Class beanType, String propertyName, Class propertyType);

    // not use, converting to optional is implemented in row creators
    ///**
    // * Convert the value to property access type.
    // * @param propertyName The name of property. (NotNull)
    // * @param propertyAccessType The class type to access the property. (NotNull)
    // * @param value The value to be converted to property type, e.g. native type or optional. (NullAllowed: if null, returns null)
    // * @return The converted value or plain value. (NullAllowed: when the value is null)
    // */
    //Object convertToPropertyAccessType(String propertyName, Class propertyAccessType, Object value);
}