/*
 * Copyright 2007-2009 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 net.paoding.rose.web.paramresolver;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

/**
 * {@link ParamMetaData} 封装对一个控制器方法的某个参数的描述
 * 
 * @author 王志亮 [qieqie.wang@gmail.com]
 */

public interface ParamMetaData {

    /**
     * 所在的控制器类
     * 
     * 
     */
    public Class<?> getControllerClass();

    /**
     * 所在的方法
     * 
     * 
     */
    public Method getMethod();

    /**
     * 该参数在方法所有参数中的位置,从0开始
     * 
     * 
     */
    public int getIndex();

    /**
     * 该参数的声明类型
     * 
     * 
     */
    public Class<?> getParamType();

    /**
     * 该参数的名字
     * 
     * 
     */
    public String getParamName();

    /**
     * 增加一个别名
     * 
     * @param aliasParamName
     * 
     */
    public void addAliasParamName(String aliasParamName);

    /**
     * 返回所有别名，数组元素如果为null，表示无效
     * 
     * 
     */
    public String[] getParamNames();

    public <T extends Annotation> T getAnnotation(Class<T> annotationClass);

    public <T extends Annotation> boolean isAnnotationPresent(Class<T> annotationClass);

    public void setUserObject(Object key, Object userObject);

    public Object getUserObject(Object key);

}