Cancellable.java

/*
 * WorldEdit, a Minecraft world manipulation toolkit
 * Copyright (C) sk89q <http://www.sk89q.com>
 * Copyright (C) WorldEdit team and contributors
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package com.supaham.commons.events;

/**
 * Represents an {@link Event} that has a cancellable state. The meaning of cancellation depends on
 * the event.
 *
 * @since 0.1
 */
public interface Cancellable {

  /**
   * Check whether this {@link Cancellable} event has been cancelled.
   *
   * @return true if cancelled
   */
  boolean isCancelled();

  /**
   * Sets whether this {@link Cancellable} event has been cancelled.
   *
   * @param cancelled true to cancel the event
   */
  void setCancelled(boolean cancelled);

}