com.comphenix.xp.mods

Class BlockResponse

java.lang.Object

com.comphenix.xp.mods.BlockResponse

public class BlockResponse
extends java.lang.Object

Represents a immutable block service response.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static BlockResponse	CUSTOM A response indicating success, but that that ExperienceMod should leave everything up to the caller.
static BlockResponse	FAILURE A response indicating failure.

Constructor Summary

Constructors

Constructor and Description
BlockResponse(boolean success)
BlockResponse(boolean success, org.bukkit.event.inventory.InventoryType defaultBehavior, java.lang.String actionType, java.lang.String permission)
BlockResponse(org.bukkit.event.inventory.InventoryType defaultBehavior, java.lang.String actionType, java.lang.String permission)
BlockResponse(java.lang.String actionType, java.lang.String permission)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getActionType() Retrieves the current action type (or trigger).
org.bukkit.inventory.ItemStack	getCurrentItem() The current item to override with InventoryClickEvent.
org.bukkit.event.inventory.InventoryType	getDefaultBehavior() Retrieves the default behavior that will handle the inventory event.
org.bukkit.inventory.ItemStack	getOverridableCurrentItem(org.bukkit.event.inventory.InventoryClickEvent event) If override current is FALSE, return the current item in the given event.
java.lang.String	getPermission() Retrieves the permission this player must have in order to be rewarded.
boolean	hasDefaultBehavior() Whether or not this response contains a default behavior.
int	hashCode()
boolean	isForceHack() Whether or not to always derive the crafted items from how the player inventory changed.
boolean	isOverrideCurrent() Whether or not to override the default current item in InventoryClickEvent.
boolean	isSuccess() Whether or not this block provider can handle the current inventory event.
static boolean	isSuccessful(BlockResponse response) Determines if a given block response is successful.
void	setActionType(java.lang.String actionType) Sets the current action type.
void	setCurrentItem(org.bukkit.inventory.ItemStack currentItem) Sets the current overriden item (if isOverrideCurrent is TRUE).
void	setDefaultBehavior(org.bukkit.event.inventory.InventoryType defaultBehavior) Sets the default behavior that will handle the inventory event.
void	setForceHack(boolean forceHack) Sets whether or not to always derive the crafted items from how the player inventory changed.
void	setOverrideCurrent(boolean overrideCurrent) Sets whether or not to override the default current item in InventoryClickEvent.
void	setPermission(java.lang.String permission) Sets the permission the player must have in order to be rewarded.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FAILURE

public static BlockResponse FAILURE

A response indicating failure.

CUSTOM

public static BlockResponse CUSTOM

A response indicating success, but that that ExperienceMod should leave everything up to the caller.

Constructor Detail

BlockResponse

public BlockResponse(java.lang.String actionType,
             java.lang.String permission)

BlockResponse

public BlockResponse(org.bukkit.event.inventory.InventoryType defaultBehavior,
             java.lang.String actionType,
             java.lang.String permission)

BlockResponse

public BlockResponse(boolean success)

BlockResponse

public BlockResponse(boolean success,
             org.bukkit.event.inventory.InventoryType defaultBehavior,
             java.lang.String actionType,
             java.lang.String permission)

Method Detail

isSuccess

public boolean isSuccess()

Whether or not this block provider can handle the current inventory event.

Returns:

TRUE if it can, FALSE otherwise.

getDefaultBehavior

public org.bukkit.event.inventory.InventoryType getDefaultBehavior()

Retrieves the default behavior that will handle the inventory event.

Returns:

Default behavior, or NULL for a custom behavior.

setDefaultBehavior

public void setDefaultBehavior(org.bukkit.event.inventory.InventoryType defaultBehavior)

Sets the default behavior that will handle the inventory event.

Parameters:

defaultBehavior - - new default behavior, or NULL for a custom behavior.

hasDefaultBehavior

public boolean hasDefaultBehavior()

Whether or not this response contains a default behavior.

Returns:

TRUE if it contains a default behavior, FALSE if it contains a custom behavior.

isSuccessful

public static boolean isSuccessful(BlockResponse response)

Determines if a given block response is successful.

Parameters:

response - - block response to test.

Returns:

TRUE if the response is non-null and successful.

isForceHack

public boolean isForceHack()

Whether or not to always derive the crafted items from how the player inventory changed.

Returns:

TRUE to use the hack, FALSE otherwise.

setForceHack

public void setForceHack(boolean forceHack)

Sets whether or not to always derive the crafted items from how the player inventory changed.

Parameters:

forceHack - - TRUE to force the hack method, FALSE otherwise.

getActionType

public java.lang.String getActionType()

Retrieves the current action type (or trigger).

Returns:

Action type.

setActionType

public void setActionType(java.lang.String actionType)

Sets the current action type.

Parameters:

actionType - - new action type.

isOverrideCurrent

public boolean isOverrideCurrent()

Whether or not to override the default current item in InventoryClickEvent.

Returns:

TRUE if it has been overriden, FALSE otherwise.

setOverrideCurrent

public void setOverrideCurrent(boolean overrideCurrent)

Sets whether or not to override the default current item in InventoryClickEvent.

Parameters:

overrideCurrent - - TRUE to override it, FALSE otherwise.

getCurrentItem

public org.bukkit.inventory.ItemStack getCurrentItem()

The current item to override with InventoryClickEvent.

Returns:

Current overriden item.

setCurrentItem

public void setCurrentItem(org.bukkit.inventory.ItemStack currentItem)

Sets the current overriden item (if isOverrideCurrent is TRUE).

Parameters:

currentItem - - the new overriden item.

getPermission

public java.lang.String getPermission()

Retrieves the permission this player must have in order to be rewarded.

Returns:

The permission the player must have.

setPermission

public void setPermission(java.lang.String permission)

Sets the permission the player must have in order to be rewarded.

Parameters:

permission - - the new permission the player must have.

getOverridableCurrentItem

public org.bukkit.inventory.ItemStack getOverridableCurrentItem(org.bukkit.event.inventory.InventoryClickEvent event)

If override current is FALSE, return the current item in the given event. If override current is TRUE, return the current item in the block response.

Parameters:

event - - event to draw from.

Returns:

The current event, when taking into account overriden items.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object