PlaceholderAPI/src/main/java/me/clip/placeholderapi/expansion/Taskable.java

/*
 * This file is part of PlaceholderAPI
 *
 * PlaceholderAPI
 * Copyright (c) 2015 - 2021 PlaceholderAPI Team
 *
 * PlaceholderAPI is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PlaceholderAPI is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package me.clip.placeholderapi.expansion;

/**
 * Implementing this interface adds the {@link #start() start} and {@link #stop() stop} void
 * methods to your {@link me.clip.placeholderapi.expansion.PlaceholderExpansion PlaceholderExpansion}.
 * 
 * <p>This can be used to execute methods and tasks whenever the PlaceholderExpansion has been
 * successfully (un)registered.
 */
public interface Taskable {

  /**
   * Called when the implementing class has successfully been registered to the placeholder map.
   * <br>Tasks that need to be performed when this expansion is registered should go here
   */
  void start();

  /**
   * Called when the implementing class has been unregistered from PlaceholderAPI.
   * <br>Tasks that need to be performed when this expansion has unregistered should go here
   */
  void stop();
}