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.parsers;
025
026import java.lang.annotation.ElementType;
027import java.lang.annotation.Retention;
028import java.lang.annotation.RetentionPolicy;
029import java.lang.annotation.Target;
030import java.util.function.BiFunction;
031
032/**
033 * This annotation allows you to create annotated methods that behave like argument parsers.
034 * The method must have this exact signature: <pre>{@code
035 * ﹫Parser("name") // Name may be left out
036 * public ParsedType methodName(CommandContext<YourSender> sender, Queue<String> input) {
037 * }}</pre>
038 * <p>
039 * The method can throw exceptions, and the thrown exceptions will automatically be
040 * wrapped by a {@link cloud.commandframework.arguments.parser.ArgumentParseResult#failure(Throwable)}
041 *
042 * @since 1.3.0
043 */
044@Target(ElementType.METHOD)
045@Retention(RetentionPolicy.RUNTIME)
046public @interface Parser {
047
048    /**
049     * The name of the parser. If this is left empty, the parser will
050     * be registered as a default parser for the return type of the method
051     *
052     * @return Parser name
053     */
054    String name() default "";
055
056    /**
057     * Name of the suggestions provider to use. If the string is left empty, the default
058     * provider for the {@link cloud.commandframework.annotations.Argument} will be used. Otherwise,
059     * the {@link cloud.commandframework.arguments.parser.ParserRegistry} instance in the
060     * {@link cloud.commandframework.CommandManager} will be queried for a matching suggestion provider.
061     * <p>
062     * For this to work, the suggestion needs to be registered in the parser registry. To do this, use
063     * {@link cloud.commandframework.arguments.parser.ParserRegistry#registerSuggestionProvider(String, BiFunction)}.
064     * The registry instance can be retrieved using {@link cloud.commandframework.CommandManager#getParserRegistry()}.
065     *
066     * @return The name of the suggestion provider, or {@code ""}
067     */
068    String suggestions() default "";
069
070}