net.ymate.platform.webmvc.annotation.RequestParam Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2007-2019 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.ymate.platform.webmvc.annotation;

import org.apache.commons.lang3.StringUtils;

import java.lang.annotation.*;

/**
 * 绑定请求参数
 *
 * @author 刘镇 ([email protected]) on 2012-12-20 下午3:33:12
 */
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {

    /**
     * @return 绑定的参数名称
     */
    String value() default StringUtils.EMPTY;

    /**
     * @return 绑定的参数名称前缀
     */
    String prefix() default StringUtils.EMPTY;

    /**
     * @return 默认值
     */
    String defaultValue() default StringUtils.EMPTY;

    /**
     * @return 是否尝试其它作用域下获取参数值, 优先级顺序为request->session->application, 默认为仅从request中尝试获取
     */
    boolean fullScope() default false;
}