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.exceptions;
025
026import cloud.commandframework.Command;
027import cloud.commandframework.arguments.CommandArgument;
028import org.checkerframework.checker.nullness.qual.NonNull;
029
030/**
031 * Thrown when a {@link CommandArgument}
032 * that is registered as a leaf node, does not contain an owning {@link Command}
033 */
034@SuppressWarnings("unused")
035public final class NoCommandInLeafException extends IllegalStateException {
036
037    private static final long serialVersionUID = 3373529875213310821L;
038    private final CommandArgument<?, ?> commandArgument;
039
040    /**
041     * Create a new no command in leaf exception instance
042     *
043     * @param commandArgument Command argument that caused the exception
044     */
045    public NoCommandInLeafException(final @NonNull CommandArgument<?, ?> commandArgument) {
046        super(String.format("Leaf node '%s' does not have associated owning command", commandArgument.getName()));
047        this.commandArgument = commandArgument;
048    }
049
050    /**
051     * Get the command argument
052     *
053     * @return Command argument
054     */
055    public @NonNull CommandArgument<?, ?> getCommandArgument() {
056        return this.commandArgument;
057    }
058
059}