001/*
002 *     Copyright 2021 Siroshun09
003 *
004 *     Licensed under the Apache License, Version 2.0 (the "License");
005 *     you may not use this file except in compliance with the License.
006 *     You may obtain a copy of the License at
007 *
008 *         http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *     Unless required by applicable law or agreed to in writing, software
011 *     distributed under the License is distributed on an "AS IS" BASIS,
012 *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *     See the License for the specific language governing permissions and
014 *     limitations under the License.
015 */
016
017package com.github.siroshun09.mccommand.common.context;
018
019import com.github.siroshun09.mccommand.common.Command;
020import com.github.siroshun09.mccommand.common.argument.Argument;
021import com.github.siroshun09.mccommand.common.sender.Sender;
022import org.jetbrains.annotations.NotNull;
023import org.jetbrains.annotations.Unmodifiable;
024
025import java.util.List;
026
027/**
028 * An interface that represents context of the executed command.
029 */
030public interface CommandContext {
031
032    /**
033     * Gets the executed command.
034     *
035     * @return the executed command
036     */
037    @NotNull Command getCommand();
038
039    /**
040     * Gets the commander.
041     *
042     * @return the commander
043     */
044    @NotNull Sender getSender();
045
046    /**
047     * Gets the given arguments.
048     *
049     * @return the given arguments
050     */
051    @NotNull @Unmodifiable List<Argument> getArguments();
052
053    /**
054     * Gets the string used to specify the command.
055     * <p>
056     * It may always return the same string as {@link Command#getName()}.
057     *
058     * @return the string used to specify the command
059     */
060    @NotNull String getLabel();
061}