co.aikar.commands.ExceptionHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acf-core Show documentation
The newest version!
/*
 * Copyright (c) 2016-2017 Daniel Ennis (Aikar) - MIT License
 *
 *  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 co.aikar.commands;

import java.util.List;

/**
 * Functional interface to allow plugins to handle uncaught excetpions
 */
@FunctionalInterface
public interface ExceptionHandler {

  /**
   * Called when an exception occurs while executing a command

   * If an exception handler properly handles an exception, the user will not be noticied by the
   * framework that something went unexceptected.
   *
   * @param command the command that was executed
   * @param registeredCommand the registered command
   * @param sender the issuer who send the command
   * @param args the args he used
   * @param t the throwable that caused this exception
   *
   * @return if the exception was handeled by the exception handler.
   */
  boolean execute(BaseCommand command, RegisteredCommand registeredCommand, CommandIssuer sender, List args, Throwable t);
}