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.Nonnull;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Repeatable;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Apply to <em>Resource Methods</em> to support the HTTP {@code PUT} method.
028 *
029 * @author <a href="https://www.revetkn.com">Mark Allen</a>
030 */
031@Target(ElementType.METHOD)
032@Retention(RetentionPolicy.RUNTIME)
033@Repeatable(value = PUTs.class)
034public @interface PUT {
035        /**
036         * The {@code PUT} URL that should be handled by this <em>Resource Method</em>.
037         * <p>
038         * The URL must start with a {@code /} character, e.g. {@code /widgets/{widgetId}}.
039         *
040         * @return the {@code PUT} URL that should be handled by this <em>Resource Method</em>
041         */
042        @Nonnull
043        String value();
044}