001/*
002 * Copyright 2022-2025 Revetware LLC.
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 */
016
017package com.soklet.annotation;
018
019import javax.annotation.Nullable;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025/**
026 * Apply to <em>Resource Method</em> parameters to enable URL path parameter (for example, {@code /widgets/{widgetId}}) injection.
027 * <p>
028 * Refer to documentation at <a href="https://www.soklet.com/docs/request-handling#path-parameters">https://www.soklet.com/docs/request-handling#path-parameters</a> for details.
029 *
030 * @author <a href="https://www.revetkn.com">Mark Allen</a>
031 */
032@Target(ElementType.PARAMETER)
033@Retention(RetentionPolicy.RUNTIME)
034public @interface PathParameter {
035        /**
036         * The name of the URL path parameter.
037         * <p>
038         * If {@code null} or blank, defaults to the name of the Java method parameter if your application is built with the {@code -parameters} compiler option.
039         *
040         * @return the name of the URL path parameter to inject into this <em>Resource Method</em> parameter
041         */
042        @Nullable
043        String name() default "";
044}