cloud.commandframework.fabric.argument.server.MessageArgument Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloud-fabric Show documentation
Command framework and dispatcher for the JVM
The newest version!
//
// MIT License
//
// Copyright (c) 2022 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.fabric.argument.server;

import cloud.commandframework.ArgumentDescription;
import cloud.commandframework.arguments.CommandArgument;
import cloud.commandframework.context.CommandContext;
import cloud.commandframework.fabric.argument.FabricArgumentParsers;
import cloud.commandframework.fabric.data.Message;
import java.util.List;
import java.util.function.BiFunction;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * An argument similar to a greedy string, but one that resolves selectors.
 *
 * @param  the sender type
 * @since 1.5.0
 */
public final class MessageArgument extends CommandArgument {

    MessageArgument(
            final boolean required,
            final @NonNull String name,
            final @NonNull String defaultValue,
            final @Nullable BiFunction, String, List> suggestionsProvider,
            final @NonNull ArgumentDescription defaultDescription
    ) {
        super(
                required,
                name,
                FabricArgumentParsers.message(),
                defaultValue,
                Message.class,
                suggestionsProvider,
                defaultDescription
        );
    }

    /**
     * Create a new {@link cloud.commandframework.fabric.argument.server.MessageArgument.Builder}.
     *
     * @param name Name of the argument
     * @param   Command sender type
     * @return Created builder
     * @since 1.5.0
     */
    public static  MessageArgument.@NonNull Builder builder(final @NonNull String name) {
        return new MessageArgument.Builder<>(name);
    }

    /**
     * Create a new required {@link MessageArgument}.
     *
     * @param name Component name
     * @param   Command sender type
     * @return Created argument
     * @since 1.5.0
     */
    public static  @NonNull MessageArgument of(final @NonNull String name) {
        return MessageArgument.builder(name).asRequired().build();
    }

    /**
     * Create a new optional {@link MessageArgument}.
     *
     * @param name Component name
     * @param   Command sender type
     * @return Created argument
     * @since 1.5.0
     */
    public static  @NonNull MessageArgument optional(final @NonNull String name) {
        return MessageArgument.builder(name).asOptional().build();
    }

    /**
     * Create a new optional {@link MessageArgument} with the specified value.
     *
     * @param name         Argument name
     * @param defaultValue Default value
     * @param           Command sender type
     * @return Created argument
     * @since 1.5.0
     */
    public static  @NonNull MessageArgument optional(
            final @NonNull String name,
            final @NonNull String defaultValue
    ) {
        return MessageArgument.builder(name).asOptionalWithDefault(defaultValue).build();
    }


    /**
     * Builder for {@link MessageArgument}.
     *
     * @param  sender type
     * @since 1.5.0
     */
    public static final class Builder extends TypedBuilder> {

        Builder(final @NonNull String name) {
            super(Message.class, name);
        }

        /**
         * Build a new {@link MessageArgument}.
         *
         * @return Constructed argument
         * @since 1.5.0
         */
        @Override
        public @NonNull MessageArgument build() {
            return new MessageArgument<>(
                    this.isRequired(),
                    this.getName(),
                    this.getDefaultValue(),
                    this.getSuggestionsProvider(),
                    this.getDefaultDescription()
            );
        }
    }
}