Class ClaimProtectionChangeEvent

java.lang.Object

org.bukkit.event.Event

net.mathias2246.buildmc.api.event.CustomEvent

net.mathias2246.buildmc.api.event.claims.ClaimProtectionChangeEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class ClaimProtectionChangeEvent
extends CustomEvent
implements org.bukkit.event.Cancellable

Called when a Protection of a Claim is about to change.

This event is fired before the protection status is actually updated. It is cancellable, allowing other plugins to prevent the protection status change from occurring.

This event is called when a plugin, or player toggles a protection of a claim.

If this event is cancelled, the protection status will remain unchanged.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClaimProtectionChangeEvent.ActiveState

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

Fields inherited from class CustomEvent

metadataHolder

Constructor Summary

Constructors

Constructor	Description
ClaimProtectionChangeEvent(@NotNull Claim claim, @NotNull Protection protection, @NotNull ClaimProtectionChangeEvent.ActiveState newState)

Method Summary

Modifier and Type	Method	Description
@NotNull Claim	getClaim()	Gets the claim where the protection was toggled on or off.
static org.bukkit.event.HandlerList	getHandlerList()	Gets the static list of handlers for this event type.
@NotNull org.bukkit.event.HandlerList	getHandlers()	Returns the HandlerList for this event type.
@NotNull ClaimProtectionChangeEvent.ActiveState	getNewState()	Gets the new state of the protection after the change.
@NotNull Protection	getProtection()	Gets the protection that was toggled on or off.
long	getTimestamp()	Gets when the change occurred.
boolean	isCancelled()	Gets the cancellation state of this event.
boolean	isDisabled()	If the new state of the protection is ClaimProtectionChangeEvent.ActiveState.DISABLED.
boolean	isEnabled()	If the new state of the protection is ClaimProtectionChangeEvent.ActiveState.ENABLED.
void	setCancelled(boolean b)	Sets the cancellation state of this event.

Methods inherited from class CustomEvent

getMetadata, putMetadata, removeMetadata

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClaimProtectionChangeEvent

public ClaimProtectionChangeEvent(@NotNull
 @NotNull Claim claim,
 @NotNull
 @NotNull Protection protection,
 @NotNull
 @NotNull ClaimProtectionChangeEvent.ActiveState newState)

Method Details

getClaim

@NotNull
public @NotNull Claim getClaim()

Gets the claim where the protection was toggled on or off.

getProtection

@NotNull
public @NotNull Protection getProtection()

Gets the protection that was toggled on or off.

getNewState

@NotNull
public @NotNull ClaimProtectionChangeEvent.ActiveState getNewState()

Gets the new state of the protection after the change.

getTimestamp

public long getTimestamp()

Gets when the change occurred.

isEnabled

public boolean isEnabled()

If the new state of the protection is ClaimProtectionChangeEvent.ActiveState.ENABLED.

See Also:

• getNewState()

isDisabled

public boolean isDisabled()

If the new state of the protection is ClaimProtectionChangeEvent.ActiveState.DISABLED.

See Also:

• getNewState()

isCancelled

public boolean isCancelled()

Gets the cancellation state of this event.

If this event is cancelled, the protection status will remain unchanged.

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

Returns:

If this event is cancelled

setCancelled

public void setCancelled(boolean b)

Sets the cancellation state of this event.

If this event is cancelled, the protection status will remain unchanged.

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

Parameters:

b - If the event should be cancelled or not

getHandlers

@NotNull
public @NotNull org.bukkit.event.HandlerList getHandlers()

Description copied from class: CustomEvent

Returns the HandlerList for this event type.

Bukkit requires each concrete event class to define its own static HandlerList instance and to return it from this method. This is necessary for Bukkit’s event registration and dispatch system.

Specified by:

getHandlers in class CustomEvent

Returns:

the handler list for this event (never null)

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()

Gets the static list of handlers for this event type.

Required by the Bukkit event system for registration.

Returns:

the handler list