Package org.kingdoms.constants.land

Class ProtectionSign

java.lang.Object

org.kingdoms.constants.base.CompressedSmartObject

org.kingdoms.constants.base.KingdomsObject

org.kingdoms.constants.base.KeyedKingdomsObject<SimpleLocation>

org.kingdoms.constants.land.KingdomBlock

org.kingdoms.constants.land.ProtectionSign

All Implemented Interfaces:

Keyed<SimpleLocation>, SmartObject, org.kingdoms.constants.group.model.logs.Loggable, org.kingdoms.locale.provider.CascadingMessageContextProvider, org.kingdoms.locale.provider.MessageContextProvider

public final class ProtectionSign
extends KingdomBlock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProtectionSign.AccessEntry
static enum	ProtectionSign.AccessPrivilege
static enum	ProtectionSign.ProtectionType

Field Summary

Fields inherited from class org.kingdoms.constants.land.KingdomBlock

origin

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

lastLogsExpirationCheck, logs, metadata, statistics

Fields inherited from class org.kingdoms.constants.base.CompressedSmartObject

objectState

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 List<ProtectionSign.AccessEntry> accessEntries, @Nullable Duration automaticStateToggle)

Method Summary

Modifier and Type	Method	Description
ProtectionSign.AccessPrivilege	canAccess(@NonNull UUID player)
ProtectionSign.AccessPrivilege	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 List<ProtectionSign.AccessEntry>	getAccessEntries()
@Nullable Duration	getAutomaticStateToggle()
@NonNull org.bukkit.block.Block	getBlock()
@NonNull SimpleLocation	getKey()
org.kingdoms.constants.land.KingdomBuildingHandler<?>	getKingdomBlockHandler()
@NonNull UUID	getOwner()
@NonNull org.bukkit.OfflinePlayer	getOwnerPlayer()
@Nullable String	getPassword()
static @NonNull Optional<ProtectionSign>	getProtection(@NonNull org.bukkit.block.Block block)
@NonNull ProtectionSign.ProtectionType	getProtectionType()
@NonNull SimpleLocation	getSign()
long	getSince()
@NonNull org.kingdoms.utils.cache.caffeine.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)
void	modifyData(Land land, boolean adding)
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)
void	removeProtection()
void	setAutomaticStateToggle(@Nullable Duration automaticStateToggle)
void	setHashedPassword(@Nullable String password)
void	setOwner(@NonNull UUID owner)
void	setProtectionType(@NonNull ProtectionSign.ProtectionType protectionType)
void	setTemporarilyTrusted(@NonNull org.kingdoms.utils.cache.caffeine.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.land.KingdomBlock

getLand, getOrigin

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

addMessageContextEdits, getLogs, getMetadata, getNewestLog, getNewestLog, getStatistics, log, setLogs, setMetadata, setStatistics

Methods inherited from class org.kingdoms.constants.base.CompressedSmartObject

ensureValidObject, getCompressedData, getDataHandler, hasObjectExpired, invalidateObject, isNewData, isObjectStateSaved, saveObjectState, shouldSave, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kingdoms.locale.provider.CascadingMessageContextProvider

getMessageContext

Methods inherited from interface org.kingdoms.constants.base.SmartObject

isDataEmpty

Constructor Details

ProtectionSign

public ProtectionSign(@NonNull SimpleLocation location,
 @NonNull SimpleLocation sign,
 @NonNull UUID owner,
 @NonNull ProtectionSign.ProtectionType protectionType,
 @Nullable String password,
 long since,
 @NonNull List<ProtectionSign.AccessEntry> accessEntries,
 @Nullable Duration automaticStateToggle)

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)

getAutomaticStateToggle

public @Nullable Duration getAutomaticStateToggle()

setAutomaticStateToggle

public void setAutomaticStateToggle(@Nullable Duration automaticStateToggle)

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()

getKey

public @NonNull SimpleLocation getKey()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isOwner

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

removeProtection

public void removeProtection()

getOwner

public @NonNull UUID getOwner()

setOwner

public void setOwner(@NonNull UUID owner)

getOwnerPlayer

public @NonNull org.bukkit.OfflinePlayer getOwnerPlayer()

getAccessEntries

public @NonNull List<ProtectionSign.AccessEntry> getAccessEntries()

getSign

public @NonNull SimpleLocation getSign()

canAccess

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

canAccess

public ProtectionSign.AccessPrivilege canAccess(@NonNull UUID player)

getProtectionType

public @NonNull ProtectionSign.ProtectionType getProtectionType()

setProtectionType

public void setProtectionType(@NonNull ProtectionSign.ProtectionType protectionType)

getBlock

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

getTemporarilyTrusted

public @NonNull org.kingdoms.utils.cache.caffeine.ExpirableSet<UUID> getTemporarilyTrusted()

setTemporarilyTrusted

public void setTemporarilyTrusted(@NonNull org.kingdoms.utils.cache.caffeine.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()

getKingdomBlockHandler

public org.kingdoms.constants.land.KingdomBuildingHandler<?> getKingdomBlockHandler()

Specified by:

getKingdomBlockHandler in class KingdomBlock

modifyData

public void modifyData(Land land,
 boolean adding)

Specified by:

modifyData in class KingdomBlock