org.dbflute.helper.beans.DfBeanDesc 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.helper.beans;

import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.List;

import org.dbflute.helper.beans.exception.DfBeanFieldNotFoundException;
import org.dbflute.helper.beans.exception.DfBeanMethodNotFoundException;
import org.dbflute.helper.beans.exception.DfBeanPropertyNotFoundException;

/**
 * @author modified by jflute (originated in S2Dao)
 */
public interface DfBeanDesc {

    // ===================================================================================
    //                                                                                Bean
    //                                                                                ====
    /**
     * @return The class for bean. (NotNull)
     */
    Class getBeanClass();

    // ===================================================================================
    //                                                                            Property
    //                                                                            ========
    /**
     * @param propertyName The property name of the bean, case insensitive. (NotNull)
     * @return The determination, true or false.
     */
    boolean hasPropertyDesc(String propertyName); // case insensitive

    /**
     * @param propertyName The property name of the bean, case insensitive. (NotNull)
     * @return The description object for the property. (NotNull)
     * @throws DfBeanPropertyNotFoundException When the property is not found.
     */
    DfPropertyDesc getPropertyDesc(String propertyName) throws DfBeanPropertyNotFoundException;

    int getPropertyDescSize();

    List getProppertyNameList();

    // ===================================================================================
    //                                                                               Field
    //                                                                               =====
    boolean hasField(String fieldName); // case sensitive

    Field getField(String fieldName) throws DfBeanFieldNotFoundException;

    int getFieldSize();

    // ===================================================================================
    //                                                                              Method
    //                                                                              ======
    boolean hasMethod(String methodName); // case sensitive

    Method getMethod(String methodName) throws DfBeanMethodNotFoundException;

    Method getMethod(String methodName, Class[] paramTypes) throws DfBeanMethodNotFoundException;

    Method getMethodNoException(String methodName);

    Method getMethodNoException(String methodName, Class[] paramTypes);

    Method[] getMethods(String methodName) throws DfBeanMethodNotFoundException;
}