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//
024
025package cloud.commandframework;
026
027import cloud.commandframework.arguments.CommandArgument;
028import org.checkerframework.checker.nullness.qual.NonNull;
029
030import static java.util.Objects.requireNonNull;
031
032/**
033 * A description for a {@link CommandArgument}
034 *
035 * @since 1.4.0
036 */
037public interface ArgumentDescription {
038
039    /**
040     * Get an empty command description.
041     *
042     * @return Command description
043     */
044    @SuppressWarnings("deprecation")
045    static @NonNull ArgumentDescription empty() {
046        return Description.EMPTY;
047    }
048
049    /**
050     * Create a command description instance.
051     *
052     * @param string Command description
053     * @return Created command description
054     */
055    @SuppressWarnings("deprecation")
056    static @NonNull ArgumentDescription of(final @NonNull String string) {
057        if (requireNonNull(string, "string").isEmpty()) {
058            return Description.EMPTY;
059        } else {
060            return new Description(string);
061        }
062    }
063
064    /**
065     * Get the plain-text description.
066     *
067     * @return Command description
068     */
069    @NonNull String getDescription();
070
071    /**
072     * Get whether or not this description contains contents.
073     *
074     * @return if this description is empty or not
075     */
076    default boolean isEmpty() {
077        return this.getDescription().isEmpty();
078    }
079
080}