org.dbflute.lasta.di.helper.beans.BeanDesc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lasta-di Show documentation
DI Container for LastaFlute, super forked from Seasar as Java8
The newest version!
/*
 * Copyright 2014-2015 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.lasta.di.helper.beans;

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

import org.dbflute.lasta.di.helper.beans.exception.ConstructorNotFoundRuntimeException;
import org.dbflute.lasta.di.helper.beans.exception.FieldNotFoundRuntimeException;
import org.dbflute.lasta.di.helper.beans.exception.IllegalDiiguRuntimeException;
import org.dbflute.lasta.di.helper.beans.exception.MethodNotFoundRuntimeException;
import org.dbflute.lasta.di.helper.beans.exception.PropertyNotFoundRuntimeException;

/**
 * @author modified by jflute (originated in Seasar)
 */
public interface BeanDesc {

    Class getBeanClass();

    boolean hasPropertyDesc(String propertyName);

    PropertyDesc getPropertyDesc(String propertyName) throws PropertyNotFoundRuntimeException;

    PropertyDesc getPropertyDesc(int index);

    /**
     * {@link PropertyDesc}の数を返します。
     * 
     * @return
     */
    int getPropertyDescSize();

    /**
     * 新しいインスタンスを作成します。
     * 
     * @param args
     * @return 新しいインスタンス
     * @throws ConstructorNotFoundRuntimeException
     */
    Object newInstance(Object[] args) throws ConstructorNotFoundRuntimeException;

    /**
     * 引数に応じた{@link Constructor}を返します。
     * 
     * @param args
     * @return 引数に応じた{@link Constructor}
     * @throws ConstructorNotFoundRuntimeException
     */
    Constructor getSuitableConstructor(Object[] args) throws ConstructorNotFoundRuntimeException;

    /**
     * 型に応じた{@link Constructor}を返します。
     * 
     * @param paramTypes
     * @return 型に応じた{@link Constructor}
     */
    Constructor getConstructor(Class[] paramTypes);

    /**
     * Diiguでエンハンスした{@link Constructor}のパラメータ名の配列を返します。
     * 
     * @param paramTypes
     * @return パラメータ名の配列
     */
    String[] getConstructorParameterNames(final Class[] paramTypes);

    /**
     * Diiguでエンハンスした{@link Constructor}のパラメータ名の配列を返します。
     * 
     * @param constructor
     * @return パラメータ名の配列
     */
    String[] getConstructorParameterNames(Constructor constructor);

    Object invoke(Object target, String methodName, Object[] args) throws MethodNotFoundRuntimeException;

    Method getMethod(String methodName) throws MethodNotFoundRuntimeException;

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

    Method getMethodNoException(String methodName);

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

    Method[] getMethods(String methodName) throws MethodNotFoundRuntimeException;

    boolean hasMethod(String methodName);

    String[] getMethodNames();

    String[] getMethodParameterNames(String methodName, final Class[] paramTypes) throws MethodNotFoundRuntimeException,
            IllegalDiiguRuntimeException;

    /**
     * {@link Method}のパラメータ名の配列を返します。
     * 
     * @param methodName
     * @param paramTypes
     * @return {@link Method}のパラメータ名の配列
     * @throws MethodNotFoundRuntimeException
     *             {@link Method}が見つからない場合。
     */
    String[] getMethodParameterNamesNoException(String methodName, final Class[] paramTypes) throws MethodNotFoundRuntimeException;

    /**
     * {@link Method}のパラメータ名の配列を返します。
     * 
     * @param method
     * @return {@link Method}のパラメータ名の配列
     * @throws MethodNotFoundRuntimeException
     *             {@link Method}が見つからない場合。
     * @throws IllegalDiiguRuntimeException
     *             Diiguでエンハンスされていない場合。
     */
    String[] getMethodParameterNames(Method method) throws MethodNotFoundRuntimeException, IllegalDiiguRuntimeException;

    String[] getMethodParameterNamesNoException(Method method) throws MethodNotFoundRuntimeException;

    // ===================================================================================
    //                                                                        Field Access
    //                                                                        ============
    boolean hasField(String fieldName);

    Field getField(String fieldName) throws FieldNotFoundRuntimeException;

    Field getField(int index);

    Object getFieldValue(String fieldName, Object target) throws FieldNotFoundRuntimeException;

    int getFieldSize();

    List getHiddenFieldList(String fieldName);
}