Jail/src/main/java/com/graywolf336/jail/events/PrisonerJailedEvent.java

package com.graywolf336.jail.events;

import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.bukkit.event.Event;
import org.bukkit.event.HandlerList;

import com.graywolf336.jail.beans.Jail;
import com.graywolf336.jail.beans.Prisoner;

/**
 * Event thrown when a player is fixing to be jailed, both offline and online players.
 * 
 * This event is called right before we actually jail a player, and is cancellable, whether the player is offline or online, getPlayer() will always return null if isOnline() return false.
 * 
 * @author graywolf336
 * @since 3.0.0
 * @version 1.0.0
 */
public class PrisonerJailedEvent extends Event implements Cancellable {
	private static final HandlerList handlers = new HandlerList();
	private boolean cancelled;
	private boolean online;
	private Jail jail;
	private Prisoner prisoner;
	private Player player;
	private String jailer, cancelMsg;
	
	/**
	 * Creates a new {@link PrisonerJailedEvent prisoner jailed event} for the given player.
	 * 
	 * @param jail The jail the prisoner will be jailed at.
	 * @param prisoner The prisoner data.
	 * @param player The player being jailed.
	 * @param online Whether the player is online or not.
	 * @param jailer The name of what jailed this prisoner.
	 */
	public PrisonerJailedEvent(Jail jail, Prisoner prisoner, Player player, boolean online, String jailer) {
		this.jail = jail;
		this.prisoner = prisoner;
		this.player = player;
		this.online = online;
		this.jailer = jailer;
		cancelMsg = "";
	}
	
	/** Gets the {@link Jail} this prisoner is being sent to. */
	public Jail getJail() {
		return this.jail;
	}
	
	/** Gets the {@link Prisoner} data for this prisoner. */
	public Prisoner getPrisoner() {
		return this.prisoner;
	}
	
	/** Gets the instance of the player being jailed <strong>but will return null if {@link #isOnline()} returns false</strong>. */
	public Player getPlayer() {
		return this.player;
	}
	
	/** Gets whether the prisoner being jailed is online or not. */
	public boolean isOnline() {
		return this.online;
	}
	
	/** Gets the jailer who jailed this prisoner. */
	public String getJailer() {
		return this.jailer;
	}
	
	/**
	 * Sets the prisoner whom the data should say jailed this prisoner.
	 * 
	 * @param jailer The name to put who is the jailer for this prisoner.
	 */
	public void setJailer(String jailer) {
		this.jailer = jailer;
	}
	
	/** Checks whether this event is cancelled or not. */
	public boolean isCancelled() {
		return this.cancelled;
	}

	/** Sets whether this event should be cancelled. */
	public void setCancelled(boolean cancel) {
		this.cancelled = cancel;
	}
	
	/** Returns the cancelled message. */
	public String getCancelledMessage() {
		return this.cancelMsg;
	}
	
	/** Sets the cancelled message. */
	public void setCancelledMessage(String msg) {
		this.cancelMsg = msg;
	}
	
	public static HandlerList getHandlerList() {
		return handlers;
	}

	public HandlerList getHandlers() {
		return handlers;
	}
}