Package org.kingdoms.constants.land

Class ProtectionSign

java.lang.Object

org.kingdoms.constants.metadata.KingdomsObject<SimpleLocation>

org.kingdoms.constants.land.ProtectionSign

public final class ProtectionSign
extends KingdomsObject<SimpleLocation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProtectionSign.AccessResult
static enum	ProtectionSign.ProtectionType

Field Summary

Fields inherited from class org.kingdoms.constants.metadata.KingdomsObject

metadata

Constructor Summary

Constructors

Constructor	Description
ProtectionSign(@NonNull SimpleLocation location, @NonNull SimpleLocation sign, @NonNull UUID owner, @NonNull ProtectionSign.ProtectionType protectionType, @Nullable String password, long since, @NonNull Map<UUID,Boolean> players, @NonNull Map<UUID,Boolean> kingdoms)

Method Summary

Modifier and Type	Method	Description
ProtectionSign.AccessResult	canAccess(@NonNull UUID player)
ProtectionSign.AccessResult	canAccess(@NonNull org.bukkit.OfflinePlayer player)
static boolean	canBlockBeProtected(@NonNull org.bukkit.block.Block block)
void	changePassword(@Nullable String password)
boolean	equals(Object obj)
@NonNull org.bukkit.block.Block	getBlock()
@NonNull String	getCompressedData()
@NonNull SimpleLocation	getDataKey()
@NonNull Map<UUID,Boolean>	getKingdoms()
@NonNull Land	getLand()
@NonNull SimpleLocation	getLocation()
@NonNull UUID	getOwner()
@NonNull org.bukkit.OfflinePlayer	getOwnerPlayer()
@Nullable String	getPassword()
@NonNull Map<UUID,Boolean>	getPlayers()
static @NonNull Optional<ProtectionSign>	getProtection(@NonNull org.bukkit.block.Block block)
@NonNull ProtectionSign.ProtectionType	getProtectionType()
@NonNull SimpleLocation	getSign()
long	getSince()
@NonNull ExpirableSet<UUID>	getTemporarilyTrusted()
int	hashCode()
String	hashPassword(String password)
boolean	hasPassword()
boolean	isContainer()
boolean	isOwner(@NonNull org.bukkit.OfflinePlayer player)
static boolean	isProtected(@NonNull org.bukkit.block.Block block)
static boolean	isSign(@NonNull org.bukkit.block.Block block)
static @NonNull ProtectionSign	placeProtection(@Nullable Land land, @NonNull org.bukkit.block.Block block, @NonNull org.bukkit.block.Block sign, @NonNull org.bukkit.entity.Player owner, ProtectionSign.ProtectionType protectionType)
@NonNull ProtectionSign	removeProtection()
void	setHashedPassword(@Nullable String password)
void	setKingdoms(@NonNull Map<UUID,Boolean> kingdoms)
void	setOwner(@NonNull UUID owner)
void	setPlayers(@NonNull Map<UUID,Boolean> players)
void	setProtectionType(@NonNull ProtectionSign.ProtectionType protectionType)
void	setTemporarilyTrusted(@NonNull ExpirableSet<UUID> temporarilyTrusted)
boolean	shouldRemoveProtectionAfterBreak(org.bukkit.block.Block block)	Handles doors and chests.
void	updateSign()
boolean	verifyPassword(@NonNull String password)

Methods inherited from class org.kingdoms.constants.metadata.KingdomsObject

compressBoolean, compressCollecton, compressCollecton, compressColor, compressInventory, compressLocation, compressLocation, compressMap, compressMetadata, compressString, compressUUID, getMetadata, getSaveMeta, setMetadata, setSaveMeta, shouldSave

Methods inherited from class java.lang.Object

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

Constructor Details

ProtectionSign

public ProtectionSign(@NonNull SimpleLocation location,
 @NonNull SimpleLocation sign,
 @NonNull UUID owner,
 @NonNull ProtectionSign.ProtectionType protectionType,
 @Nullable String password,
 long since,
 @NonNull Map<UUID,Boolean> players,
 @NonNull Map<UUID,Boolean> kingdoms)

Method Details

isProtected

public static boolean isProtected(@NonNull org.bukkit.block.Block block)

canBlockBeProtected

public static boolean canBlockBeProtected(@NonNull org.bukkit.block.Block block)

placeProtection

public static @NonNull ProtectionSign placeProtection(@Nullable Land land,
 @NonNull org.bukkit.block.Block block,
 @NonNull org.bukkit.block.Block sign,
 @NonNull org.bukkit.entity.Player owner,
 ProtectionSign.ProtectionType protectionType)

shouldRemoveProtectionAfterBreak

public boolean shouldRemoveProtectionAfterBreak(org.bukkit.block.Block block)

Handles doors and chests.

getProtection

public static @NonNull Optional<ProtectionSign> getProtection(@NonNull org.bukkit.block.Block block)

isSign

public static boolean isSign(@NonNull org.bukkit.block.Block block)

isContainer

public boolean isContainer()

getSince

public long getSince()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

updateSign

public void updateSign()

getDataKey

public @NonNull SimpleLocation getDataKey()

Specified by:

getDataKey in class KingdomsObject<SimpleLocation>

getCompressedData

public @NonNull String getCompressedData()

Specified by:

getCompressedData in class KingdomsObject<SimpleLocation>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isOwner

public boolean isOwner(@NonNull org.bukkit.OfflinePlayer player)

removeProtection

public @NonNull ProtectionSign removeProtection()

getOwner

public @NonNull UUID getOwner()

setOwner

public void setOwner(@NonNull UUID owner)

getOwnerPlayer

public @NonNull org.bukkit.OfflinePlayer getOwnerPlayer()

getPlayers

public @NonNull Map<UUID,Boolean> getPlayers()

setPlayers

public void setPlayers(@NonNull Map<UUID,Boolean> players)

getKingdoms

public @NonNull Map<UUID,Boolean> getKingdoms()

setKingdoms

public void setKingdoms(@NonNull Map<UUID,Boolean> kingdoms)

getSign

public @NonNull SimpleLocation getSign()

canAccess

public ProtectionSign.AccessResult canAccess(@NonNull org.bukkit.OfflinePlayer player)

canAccess

public ProtectionSign.AccessResult canAccess(@NonNull UUID player)

getProtectionType

public @NonNull ProtectionSign.ProtectionType getProtectionType()

setProtectionType

public void setProtectionType(@NonNull ProtectionSign.ProtectionType protectionType)

getLand

public @NonNull Land getLand()

getLocation

public @NonNull SimpleLocation getLocation()

getBlock

public @NonNull org.bukkit.block.Block getBlock()

getTemporarilyTrusted

public @NonNull ExpirableSet<UUID> getTemporarilyTrusted()

setTemporarilyTrusted

public void setTemporarilyTrusted(@NonNull ExpirableSet<UUID> temporarilyTrusted)

getPassword

public @Nullable String getPassword()

setHashedPassword

public void setHashedPassword(@Nullable String password)

changePassword

public void changePassword(@Nullable String password)

verifyPassword

public boolean verifyPassword(@NonNull String password)

hashPassword

public String hashPassword(String password)

hasPassword

public boolean hasPassword()