com.jianggujin.http.support.annotation.JPathParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of JHttp Show documentation

HTTP请求工具

The newest version!

/**
 * Copyright 2018 jianggujin (www.jianggujin.com).
 * 
 * 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 com.jianggujin.http.support.annotation;

import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.util.Map;

/**
 * 路径参数
 * 
 * 如果方法参数类型为{@link String}，则{@link #value()}必须配置，对应值为路径参数名称，方法参数为路径参数值；
 * 如果方法参数类型为{@link Map}，则所有参数无效，方法参数即为路径参数数据
 * 
 * 
 * @author jianggujin
 *
 */
@Retention(RUNTIME)
@Target(PARAMETER)
public @interface JPathParam {
    /**
     * 参数名称
     * 
     * @return
     */
    String value() default "";

    /**
     * 是否必填
     * 
     * @return
     */
    boolean required() default true;
}