001/*
002 * Copyright (c) 2016-2017 Daniel Ennis (Aikar) - MIT License
003 *
004 *  Permission is hereby granted, free of charge, to any person obtaining
005 *  a copy of this software and associated documentation files (the
006 *  "Software"), to deal in the Software without restriction, including
007 *  without limitation the rights to use, copy, modify, merge, publish,
008 *  distribute, sublicense, and/or sell copies of the Software, and to
009 *  permit persons to whom the Software is furnished to do so, subject to
010 *  the following conditions:
011 *
012 *  The above copyright notice and this permission notice shall be
013 *  included in all copies or substantial portions of the Software.
014 *
015 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
016 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
017 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
018 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
019 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
020 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
021 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
022 */
023
024package co.aikar.commands;
025
026import java.lang.annotation.Annotation;
027import java.util.List;
028
029/**
030 * Holds information about the currently executing command on this thread
031 */
032public class CommandOperationContext<I extends CommandIssuer> {
033
034    private final CommandManager manager;
035    private final I issuer;
036    private final BaseCommand command;
037    private final String commandLabel;
038    private final String[] args;
039    private final boolean isAsync;
040    private RegisteredCommand registeredCommand;
041    List<String> enumCompletionValues;
042
043    CommandOperationContext(CommandManager manager, I issuer, BaseCommand command, String commandLabel, String[] args, boolean isAsync) {
044        this.manager = manager;
045        this.issuer = issuer;
046        this.command = command;
047        this.commandLabel = commandLabel;
048        this.args = args;
049        this.isAsync = isAsync;
050    }
051
052    public CommandManager getCommandManager() {
053        return manager;
054    }
055
056    public I getCommandIssuer() {
057        return issuer;
058    }
059
060    public BaseCommand getCommand() {
061        return command;
062    }
063
064    public String getCommandLabel() {
065        return commandLabel;
066    }
067
068    public String[] getArgs() {
069        return args;
070    }
071
072    public boolean isAsync() {
073        return isAsync;
074    }
075
076    public void setRegisteredCommand(RegisteredCommand registeredCommand) {
077        this.registeredCommand = registeredCommand;
078    }
079
080    public RegisteredCommand getRegisteredCommand() {
081        return registeredCommand;
082    }
083
084    /**
085     * This method will not support annotation processors!! use getAnnotationValue or hasAnnotation
086     *
087     * @deprecated Use {@link #getAnnotationValue(Class)}
088     */
089    @Deprecated
090    public <T extends Annotation> T getAnnotation(Class<T> anno) {
091        return registeredCommand.method.getAnnotation(anno);
092    }
093
094    public <T extends Annotation> String getAnnotationValue(Class<T> cls) {
095        return manager.getAnnotations().getAnnotationValue(registeredCommand.method, cls);
096    }
097
098    public <T extends Annotation> String getAnnotationValue(Class<T> cls, int options) {
099        return manager.getAnnotations().getAnnotationValue(registeredCommand.method, cls, options);
100    }
101
102    public boolean hasAnnotation(Class<? extends Annotation> anno) {
103        return getAnnotation(anno) != null;
104    }
105
106}