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 com.soklet.internal.classindex.IndexAnnotated;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * This annotation must be present on a class for <em>Resource Methods</em> to be detected.
028 * <p>
029 * For example:
030 * <pre>{@code  @Resource // This annotation must be here for @GET to work
031 * public class MyResource {
032 *   @GET("/")
033 *   public String index() {
034 *     return "Hello, world!";
035 *   }
036 * }}</pre>
037 *
038 * @author <a href="https://www.revetkn.com">Mark Allen</a>
039 */
040@Target(ElementType.TYPE)
041@Retention(RetentionPolicy.RUNTIME)
042@IndexAnnotated
043public @interface Resource {}