001/**
002 * Copyright (C) 2006-2024 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.api.service.http;
017
018import static java.lang.annotation.ElementType.PARAMETER;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.lang.annotation.Retention;
022import java.lang.annotation.Target;
023
024/**
025 * Marks a parameter as a path template.
026 */
027@Target(PARAMETER)
028@Retention(RUNTIME)
029public @interface Path {
030
031    /**
032     * @return the path name in the template.
033     */
034    String value();
035
036    /**
037     * @return should the value be encoded.
038     */
039    boolean encode() default true;
040}