Package org.kingdoms.constants.group

Class Nation

java.lang.Object

org.kingdoms.constants.base.CompressedSmartObject

org.kingdoms.constants.base.KingdomsObject

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

org.kingdoms.constants.group.Group

org.kingdoms.constants.group.Nation

All Implemented Interfaces:

org.kingdoms.abstraction.GroupOperator, org.kingdoms.abstraction.Levellable, org.kingdoms.abstraction.NamespacedFlagsContainer, NationOperator, Keyed<UUID>, SmartObject, org.kingdoms.constants.group.model.logs.Loggable, org.kingdoms.constants.themes.ThemeContainer, org.kingdoms.locale.provider.CascadingMessageContextProvider, org.kingdoms.locale.provider.MessageContextProvider

@NonExtendable
public class Nation
extends Group
implements NationOperator

Field Summary

Fields inherited from class org.kingdoms.constants.group.Group

attributes, bank, book, colors, flags, home, id, level, members, name, nexus, owner, ranks, relations, relationshipRequests, resourcePoints, shield, since, tag, taxes

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
Nation(UUID id, Map<UUID,KingdomRelationshipRequest> relationshipRequests, RankMap ranks, Map<UUID,KingdomRelation> relations, Set<UUID> kingdoms, UUID capital, String name, int level, org.kingdoms.constants.namespace.NamespacedMap<org.kingdoms.utils.compilers.expressions.MathExpression> taxes, SimpleLocation nexus, org.kingdoms.server.location.Location home, GroupBanner flag, GroupBanner banner, org.kingdoms.constants.namespace.NamespacedMap<Color> colors, org.kingdoms.constants.economy.Balance resourcePoints, org.kingdoms.constants.economy.Balance bank, org.kingdoms.constants.namespace.NamespacedFlags flags, org.kingdoms.constants.stats.Statistics stats, long since, org.kingdoms.constants.group.Shield shield, @NonNull Map<KingdomRelation,Set<org.kingdoms.constants.group.model.relationships.RelationAttribute>> attributes)
Nation(@NonNull Kingdom capital, @NonNull String name)

Method Summary

Modifier and Type	Method	Description
KingdomRelationshipRequest	acceptRelationshipRequest(Nation nation)
double	calculateTax()
@NonNull org.kingdoms.data.Pair<Boolean,Double>	collectTaxesFrom(@NonNull Kingdom kingdom)
@NonNull NationDisbandEvent	disband(GroupDisband.Reason reason, Runnable predataRemoval)
@NonNull Kingdom	getCapital()
@NonNull UUID	getCapitalId()
protected org.kingdoms.data.handlers.abstraction.DataHandler<Nation>	getDataHandler()	Used for serialization of the smart object into a compressed state to determine CompressedSmartObject.shouldSave()
@NonNull List<KingdomPlayer>	getKingdomPlayers()
@NonNull List<Kingdom>	getKingdoms()
Map<String,Set<SimpleChunkLocation>>	getLands(boolean includeNationZones)
int	getLevel()	This option is affected by forced levels config option if it's enabled (e.g.
int	getMaxMembers()
Nation	getNation()
static @Nullable Nation	getNation(@NonNull String name)
static @Nullable Nation	getNation(@NonNull UUID id)
@NonNull List<org.bukkit.entity.Player>	getOnlineMembers()
@NonNull List<org.bukkit.OfflinePlayer>	getPlayerMembers()
@NonNull KingdomRelation	getRelationWith(@Nullable Nation nation)
double	getTax(Kingdom kingdom)
boolean	hasAttribute(@Nullable Nation nation, StandardRelationAttribute attribute)
boolean	isMember(org.bukkit.OfflinePlayer player)
boolean	isMember(@NonNull Kingdom kingdom)
boolean	isMember(KingdomPlayer player)
NexusMoveEvent	placeOrMoveNexus(org.kingdoms.server.location.Location toLocation, @Nullable KingdomPlayer kp)
@NonNull GroupRenameEvent	rename(@NonNull String name, @Nullable KingdomPlayer renamer)
KingdomRelation	revokeRelationsWith(@NonNull Nation nation)
KingdomRelationshipRequest	sendRelationshipRequest(@Nullable KingdomPlayer sender, @NonNull Nation nation, @NonNull KingdomRelation relation)
KingdomRelationshipRequest	sendRelationshipRequest(@Nullable KingdomPlayer sender, @NonNull Nation nation, @NonNull KingdomRelation relation, long acceptTime)
void	setCapital(@NonNull Kingdom newCapital)
NationSetSpawnEvent	setHome(org.kingdoms.server.location.Location home, KingdomPlayer kp)
void	silentlyDisband()
void	updateRankNode(@NonNull String node, @NonNull String newNode)

Methods inherited from class org.kingdoms.constants.group.Group

abstractPlaceOrMoveNexus, addMessageContextEdits, changeLevel, countRelationships, disband, equals, getAttributes, getBank, getBankruptcy, getBanner, getBook, getColors, getFlag, getFlags, getGroup, getHome, getId, getKey, getMailIds, getMails, getMembers, getName, getNexus, getOwnerId, getRanks, getRawLevel, getReceivedMails, getRelations, getRelationshipRequests, getResourcePoints, getSentMails, getShield, getSince, getTag, getTax, getTaxes, getThemes, hasAttribute, hashCode, hasOwner, isFull, isHidden, isHomePublic, isMember, isPermanent, renameTag, requiresInvite, sendMail, sendMail, setAttributes, setBanner, setBook, setColor, setFlag, setFlags, setHidden, setLevel, setName, setNexus, setPermanent, setPublicHome, setRanks, setRelations, setRelationshipRequests, setRelationShipWith, setRequiresInvite, setSince, setTag, setTax, toString, unsafeGetMembers, unsafeGetRelations

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, hasObjectExpired, invalidateObject, isNewData, isObjectStateSaved, saveObjectState, shouldSave

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.abstraction.NationOperator

getGroup

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

isDataEmpty

Constructor Details

Nation

public Nation(@NonNull Kingdom capital,
 @NonNull String name)

Nation

public Nation(UUID id,
 Map<UUID,KingdomRelationshipRequest> relationshipRequests,
 RankMap ranks,
 Map<UUID,KingdomRelation> relations,
 Set<UUID> kingdoms,
 UUID capital,
 String name,
 int level,
 org.kingdoms.constants.namespace.NamespacedMap<org.kingdoms.utils.compilers.expressions.MathExpression> taxes,
 SimpleLocation nexus,
 org.kingdoms.server.location.Location home,
 GroupBanner flag,
 GroupBanner banner,
 org.kingdoms.constants.namespace.NamespacedMap<Color> colors,
 org.kingdoms.constants.economy.Balance resourcePoints,
 org.kingdoms.constants.economy.Balance bank,
 org.kingdoms.constants.namespace.NamespacedFlags flags,
 org.kingdoms.constants.stats.Statistics stats,
 long since,
 org.kingdoms.constants.group.Shield shield,
 @NonNull Map<KingdomRelation,Set<org.kingdoms.constants.group.model.relationships.RelationAttribute>> attributes)

Method Details

getNation

public static @Nullable Nation getNation(@NonNull String name)

getNation

public static @Nullable Nation getNation(@NonNull UUID id)

getLands

public Map<String,Set<SimpleChunkLocation>> getLands(boolean includeNationZones)

See Also:

• Land.getNationZone(SimpleChunkLocation)

getCapital

public @NonNull Kingdom getCapital()

setCapital

public void setCapital(@NonNull Kingdom newCapital)

getCapitalId

public @NonNull UUID getCapitalId()

getLevel

public int getLevel()

Description copied from class: Group

This option is affected by forced levels config option if it's enabled (e.g. KingdomsConfig.GROUP_LEVELS_KINGDOMS_FORCE) The raw level is accessed from Group.getRawLevel() but you shouldn't need to use that method in almost all cases.

Specified by:

getLevel in interface org.kingdoms.abstraction.Levellable

Overrides:

getLevel in class Group

getKingdoms

public @NonNull List<Kingdom> getKingdoms()

setHome

public NationSetSpawnEvent setHome(org.kingdoms.server.location.Location home,
 KingdomPlayer kp)

Specified by:

setHome in class Group

calculateTax

public double calculateTax()

Specified by:

calculateTax in class Group

getMaxMembers

public int getMaxMembers()

Specified by:

getMaxMembers in class Group

rename

public @NonNull GroupRenameEvent rename(@NonNull String name,
 @Nullable KingdomPlayer renamer)

Specified by:

rename in class Group

getOnlineMembers

public @NonNull List<org.bukkit.entity.Player> getOnlineMembers()

Specified by:

getOnlineMembers in class Group

getPlayerMembers

public @NonNull List<org.bukkit.OfflinePlayer> getPlayerMembers()

Specified by:

getPlayerMembers in class Group

getKingdomPlayers

public @NonNull List<KingdomPlayer> getKingdomPlayers()

Specified by:

getKingdomPlayers in class Group

disband

public @NonNull NationDisbandEvent disband(GroupDisband.Reason reason,
 Runnable predataRemoval)

Specified by:

disband in class Group

silentlyDisband

public void silentlyDisband()

isMember

public boolean isMember(@NonNull Kingdom kingdom)

isMember

public boolean isMember(org.bukkit.OfflinePlayer player)

isMember

public boolean isMember(KingdomPlayer player)

getTax

public double getTax(Kingdom kingdom)

collectTaxesFrom

public @NonNull org.kingdoms.data.Pair<Boolean,Double> collectTaxesFrom(@NonNull Kingdom kingdom)

getRelationWith

public @NonNull KingdomRelation getRelationWith(@Nullable Nation nation)

placeOrMoveNexus

public NexusMoveEvent placeOrMoveNexus(org.kingdoms.server.location.Location toLocation,
 @Nullable KingdomPlayer kp)

Specified by:

placeOrMoveNexus in class Group

hasAttribute

public boolean hasAttribute(@Nullable Nation nation,
 StandardRelationAttribute attribute)

acceptRelationshipRequest

public KingdomRelationshipRequest acceptRelationshipRequest(Nation nation)

sendRelationshipRequest

public KingdomRelationshipRequest sendRelationshipRequest(@Nullable KingdomPlayer sender,
 @NonNull Nation nation,
 @NonNull KingdomRelation relation,
 long acceptTime)

sendRelationshipRequest

public KingdomRelationshipRequest sendRelationshipRequest(@Nullable KingdomPlayer sender,
 @NonNull Nation nation,
 @NonNull KingdomRelation relation)

updateRankNode

public void updateRankNode(@NonNull String node,
 @NonNull String newNode)

Specified by:

updateRankNode in class Group

revokeRelationsWith

public KingdomRelation revokeRelationsWith(@NonNull Nation nation)

getNation

public Nation getNation()

Specified by:

getNation in interface NationOperator

getDataHandler

protected org.kingdoms.data.handlers.abstraction.DataHandler<Nation> getDataHandler()

Description copied from class: CompressedSmartObject

Used for serialization of the smart object into a compressed state to determine CompressedSmartObject.shouldSave()

Overrides:

getDataHandler in class CompressedSmartObject