/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered <https://www.spongepowered.org>
 * Copyright (c) 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 org.spongepowered.api.command;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.spongepowered.api.Sponge;
import org.spongepowered.api.text.Text;
import org.spongepowered.api.util.ResettableBuilder;

/**
 * Represents the result of a command in Sponge.
 */
public interface CommandResult {

    /**
     * Creates a builder that creates {@link CommandResult}s.
     *
     * @return The {@link Builder}
     */
    static Builder builder() {
        return Sponge.getRegistry().getBuilderRegistry().provideBuilder(Builder.class);
    }

    /**
     * Builds a result that indicates successes.
     *
     * @return The {@link CommandResult}
     */
    static CommandResult success() {
        return CommandResults.SUCCESS;
    }

    /**
     * Builds an empty result.
     *
     * @return The {@link CommandResult}
     */
    static CommandResult empty() {
        return CommandResults.EMPTY;
    }

    /**
     * Builds an empty result that will prompt the command manager to send an
     * error message without throwing an exception.
     *
     * @param errorMessage The error message to send
     * @return The {@link CommandResult}
     */
    static CommandResult error(Text errorMessage) {
        return builder().error(errorMessage).build();
    }

    /**
     * Gets whether the command executed successfully.
     *
     * @return {@code true} if so.
     */
    boolean isSuccess();

    /**
     * Gets the integer result returned by the command that executed.
     *
     * @return The result.
     */
    int getResult();

    /**
     * Builds {@link CommandResult}s.
     */
    interface Builder extends ResettableBuilder<CommandResult, Builder> {

        /**
         * Sets an integer value that indicates the states of the
         * command.
         *
         * <ul>
         *     <li>A positive value indicates successful execution,</li>
         *     <li>Zero indicates the command didn't fulfil its task</li>
         *     <li>A negative value is undefined in the API, if returned, the
         *     effects are implementation specific.</li>
         * </ul>
         *
         * @param result The integer result to set
         * @return This builder, for chaining
         */
        Builder setResult(int result);

        /**
         * Sets or removes the error message to return to the user without
         * throwing an exception.
         *
         * <p>If this is set, then the command parser will send this message to
         * the command invoker.</p>
         *
         * @param errorMessage The message to send to the user.
         * @return This builder, for chaining
         */
        Builder error(@Nullable Text errorMessage);

        /**
         * Builds the {@link CommandResult}.
         *
         * @return A CommandResult with the specified settings
         */
        CommandResult build();

    }

}

@@ -1475,16 +1475,44 @@
 ilder;%0A%0A
+import java.util.Optional;%0A%0A
 /**%0A * R
@@ -2488,16 +2488,22 @@
 t error(
+final 
 Text err
@@ -2853,24 +2853,198 @@
 tResult();%0A%0A
+    /**%0A     * If present, returns the error message associated with this result.%0A     *%0A     * @return The error %7B@link Text%7D%0A     */%0A    Optional%3CText%3E getErrorMessage();%0A%0A
     /**%0A    

Add missing getter