001//
002// MIT License
003//
004// Copyright (c) 2021 Alexander Söderberg & Contributors
005//
006// Permission is hereby granted, free of charge, to any person obtaining a copy
007// of this software and associated documentation files (the "Software"), to deal
008// in the Software without restriction, including without limitation the rights
009// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010// copies of the Software, and to permit persons to whom the Software is
011// furnished to do so, subject to the following conditions:
012//
013// The above copyright notice and this permission notice shall be included in all
014// copies or substantial portions of the Software.
015//
016// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
022// SOFTWARE.
023//
024package cloud.commandframework.annotations.suggestions;
025
026import org.checkerframework.checker.nullness.qual.NonNull;
027
028import java.lang.annotation.ElementType;
029import java.lang.annotation.Retention;
030import java.lang.annotation.RetentionPolicy;
031import java.lang.annotation.Target;
032
033/**
034 * This annotation allows you to create annotated methods that behave like suggestions providers.
035 * The method must have this exact signature: <pre>{@code
036 * ﹫Suggestions("name")
037 * public List<String> methodName(CommandContext<YourSender> sender, String input) {
038 * }}</pre>
039 *
040 * @since 1.3.0
041 */
042@Target(ElementType.METHOD)
043@Retention(RetentionPolicy.RUNTIME)
044public @interface Suggestions {
045
046    /**
047     * Name of the suggestions provider. This should be the same as the name specified in your command arguments
048     *
049     * @return Suggestions provider name
050     */
051    @NonNull String value();
052
053}