Package org.kingdoms.constants.player

Class Rank

java.lang.Object

org.kingdoms.constants.base.CompressedSmartObject

org.kingdoms.constants.base.KingdomsObject

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

org.kingdoms.constants.player.Rank

All Implemented Interfaces:

Cloneable, Comparable<Rank>, Keyed<String>, SmartObject, org.kingdoms.constants.group.model.logs.Loggable, org.kingdoms.locale.provider.CascadingMessageContextProvider, org.kingdoms.locale.provider.MessageContextProvider

public class Rank
extends KeyedKingdomsObject<String>
implements Comparable<Rank>, Cloneable

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	CUSTOM_RANKS

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
Rank(@NonNull String node, String name, String color, String symbol, com.cryptomorin.xseries.XMaterial material, int priority, int maxClaims, Set<KingdomPermission> permissions)

Method Summary

Modifier and Type	Method	Description
void	addMessageContextEdits(@NotNull MessagePlaceholderProvider context)
boolean	canBePromoted()	Whether this rank can be promoted.
@NonNull Rank	clone()
int	compareTo(@NonNull Rank rank)
static RankMap	copyDefaults(boolean national)
static RankMap	copyDefaults(Group group)
Set<KingdomPermission>	copyPermissions()
static @Nullable KingdomPlayer	determineNextKing(@NonNull List<KingdomPlayer> members, boolean orKeepIfNone)
boolean	equals(Object obj)
@Nullable String	getColor()
static RankMap	getDefaultKingdomRanks()
static Rank	getHighestRank()
@NonNull String	getKey()
static @NonNull Rank	getLowestRank()
@NonNull com.cryptomorin.xseries.XMaterial	getMaterial()
int	getMaxClaims()
@Nullable String	getName()
@NonNull String	getNode()
@NonNull Set<KingdomPermission>	getPermissions()
@org.checkerframework.common.value.qual.IntRange(from=0L, to=2147483647L) int	getPriority()	Rank priorities start from zero.
@Nullable String	getSymbol()
int	hashCode()
boolean	hasPermission(KingdomPermission permission)
static void	init()
boolean	isHigherThan(@NonNull Rank rank)	Checks whether this rank has higher priority than the given rank.
boolean	isKing()
void	setColor(@Nullable String color)
void	setMaterial(com.cryptomorin.xseries.XMaterial material)
void	setMaxClaims(int maxClaims)
void	setName(@Nullable String name)
protected void	setNode(@NonNull String node)
void	setPermissions(@NonNull Set<KingdomPermission> permissions)
protected void	setPriority(@org.checkerframework.common.value.qual.IntRange(from=0L, to=2147483647L) int priority)
void	setSymbol(@Nullable String symbol)
String	toShortString()
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Field Details

CUSTOM_RANKS

public static boolean CUSTOM_RANKS

Constructor Details

Rank

public Rank(@NonNull String node,
 String name,
 String color,
 String symbol,
 com.cryptomorin.xseries.XMaterial material,
 int priority,
 int maxClaims,
 Set<KingdomPermission> permissions)

Method Details

copyDefaults

public static RankMap copyDefaults(Group group)

copyDefaults

public static RankMap copyDefaults(boolean national)

init

public static void init()

getDefaultKingdomRanks

public static RankMap getDefaultKingdomRanks()

determineNextKing

public static @Nullable KingdomPlayer determineNextKing(@NonNull List<KingdomPlayer> members,
 boolean orKeepIfNone)

getHighestRank

public static Rank getHighestRank()

getLowestRank

public static @NonNull Rank getLowestRank()

copyPermissions

public Set<KingdomPermission> copyPermissions()

hasPermission

public boolean hasPermission(KingdomPermission permission)

clone

public @NonNull Rank clone()

Overrides:

clone in class Object

compareTo

public int compareTo(@NonNull Rank rank)

Specified by:

compareTo in interface Comparable<Rank>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getKey

public @NonNull String getKey()

Specified by:

getKey in interface Keyed<String>

toString

public String toString()

Overrides:

toString in class CompressedSmartObject

toShortString

public String toShortString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isHigherThan

public boolean isHigherThan(@NonNull Rank rank)

Checks whether this rank has higher priority than the given rank.

See Also:

• getPriority()

isKing

public boolean isKing()

getNode

public @NonNull String getNode()

setNode

protected void setNode(@NonNull String node)

canBePromoted

public boolean canBePromoted()

Whether this rank can be promoted. The king rank and a rank below the king rank ("general" by default) cannot be "promoted" the general must simply be "set" as king.

getMaterial

public @NonNull com.cryptomorin.xseries.XMaterial getMaterial()

setMaterial

public void setMaterial(com.cryptomorin.xseries.XMaterial material)

getName

public @Nullable String getName()

setName

public void setName(@Nullable String name)

getColor

public @Nullable String getColor()

setColor

public void setColor(@Nullable String color)

getSymbol

public @Nullable String getSymbol()

setSymbol

public void setSymbol(@Nullable String symbol)

getMaxClaims

public int getMaxClaims()

setMaxClaims

public void setMaxClaims(int maxClaims)

getPriority

public @org.checkerframework.common.value.qual.IntRange(from=0L, to=2147483647L) int getPriority()

Rank priorities start from zero. King has priority 0 This means that "less important" ranks have higher priority.

See Also:

• isHigherThan(Rank)

setPriority

@Internal
protected void setPriority(@org.checkerframework.common.value.qual.IntRange(from=0L, to=2147483647L) int priority)

getPermissions

public @NonNull Set<KingdomPermission> getPermissions()

setPermissions

public void setPermissions(@NonNull Set<KingdomPermission> permissions)

addMessageContextEdits

public void addMessageContextEdits(@NotNull
 @NotNull MessagePlaceholderProvider context)

Specified by:

addMessageContextEdits in interface org.kingdoms.locale.provider.CascadingMessageContextProvider

Overrides:

addMessageContextEdits in class KingdomsObject