com.massivecraft.factions.zcore.persist

## Class MemoryFaction

- java.lang.Object
- - com.massivecraft.factions.zcore.persist.MemoryFaction

- All Implemented Interfaces:
    Faction, EconomyParticipator, RelationParticipator
  Direct Known Subclasses:
    JSONFaction

      public abstract class MemoryFaction
      extends java.lang.Object
      implements Faction, EconomyParticipator

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected java.util.HashMap<java.lang.String,java.util.List<java.lang.String>>` | `announcements`
    `protected java.util.Set<BanInfo>` | `bans`
    `org.bukkit.Location` | `checkpoint`
    `protected java.util.Map<FLocation,java.util.Set<java.lang.String>>` | `claimOwnership`
    `protected Role` | `defaultRole`
    `protected java.lang.String` | `description`
    `protected long` | `foundedDate`
    `protected java.util.Set<FPlayer>` | `fplayers`
    `protected LazyLocation` | `home`
    `protected java.lang.String` | `id`
    `protected java.util.Set<java.lang.String>` | `invites`
    `protected long` | `lastPlayerLoggedOffTime`
    `protected int` | `maxVaults`
    `protected double` | `money`
    `protected boolean` | `open`
    `protected java.lang.String` | `paypal`
    `protected boolean` | `peaceful`
    `protected boolean` | `peacefulExplosionsEnabled`
    `protected boolean` | `permanent`
    `protected java.lang.Integer` | `permanentPower`
    `protected java.util.Map<Permissable,java.util.Map<PermissableAction,Access>>` | `permissions`
    `protected java.lang.String` | `player`
    `protected double` | `powerBoost`
    `protected java.util.Map<java.lang.String,Relation>` | `relationWish`
    `java.util.HashMap<java.lang.Integer,java.lang.String>` | `rules`
    `protected java.lang.String` | `tag`
    `int` | `tnt`
    `java.util.HashMap<java.lang.String,java.lang.Integer>` | `upgrades`
    `LazyLocation` | `vault`
    `protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String>` | `warpPasswords`
    `protected java.util.concurrent.ConcurrentHashMap<java.lang.String,LazyLocation>` | `warps`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MemoryFaction()`
    `MemoryFaction(MemoryFaction old)`
    `MemoryFaction(java.lang.String id)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addAnnouncement(FPlayer fPlayer, java.lang.String msg)`
    `boolean` | `addFPlayer(FPlayer fplayer)`
    `void` | `addRule(java.lang.String rule)`
    `void` | `addTnt(int amt)`
    `void` | `ban(FPlayer target, FPlayer banner)`
    `void` | `clearAllClaimOwnership()`
    `void` | `clearClaimOwnership(FLocation loc)`
    `void` | `clearClaimOwnership(FPlayer player)`
    `void` | `clearRules()`
    `void` | `clearWarps()`
    `void` | `confirmValidHome()`
    `void` | `deinvite(FPlayer fplayer)`
    `java.lang.String` | `describeTo(RelationParticipator that)`
    `java.lang.String` | `describeTo(RelationParticipator that, boolean ucfirst)`
    `void` | `disband(org.bukkit.entity.Player disbander)`
    `boolean` | `doesLocationHaveOwnersSet(FLocation loc)`
    `Access` | `getAccess(FPlayer player, PermissableAction permissableAction)` Get the Access of a player.
    `Access` | `getAccess(Permissable permissable, PermissableAction permissableAction)`
    `java.lang.String` | `getAccountId()`
    `java.util.Set<FLocation>` | `getAllClaims()`
    `java.util.HashMap<java.lang.String,java.util.List<java.lang.String>>` | `getAnnouncements()`
    `java.util.Set<BanInfo>` | `getBannedPlayers()`
    `org.bukkit.inventory.ItemStack` | `getBanner()`
    `org.bukkit.Location` | `getCheckpoint()`
    `org.bukkit.inventory.Inventory` | `getChestInventory()`
    `java.util.Map<FLocation,java.util.Set<java.lang.String>>` | `getClaimOwnership()`
    `org.bukkit.ChatColor` | `getColorTo(RelationParticipator rp)`
    `java.lang.String` | `getComparisonTag()`
    `int` | `getCountOfClaimsWithOwners()`
    `int` | `getDeaths()`
    `Role` | `getDefaultRole()`
    `java.lang.String` | `getDescription()`
    `java.lang.String` | `getFocused()`
    `long` | `getFoundedDate()`
    `FPlayer` | `getFPlayerAdmin()`
    `java.util.Set<FPlayer>` | `getFPlayers()`
    `java.util.Set<FPlayer>` | `getFPlayersWhereOnline(boolean online)`
    `java.util.Set<FPlayer>` | `getFPlayersWhereOnline(boolean online, FPlayer viewer)`
    `java.util.ArrayList<FPlayer>` | `getFPlayersWhereRole(Role role)`
    `org.bukkit.Location` | `getHome()`
    `java.lang.String` | `getId()`
    `java.util.Set<java.lang.String>` | `getInvites()`
    `int` | `getKills()`
    `int` | `getLandRounded()`
    `int` | `getLandRoundedInWorld(java.lang.String worldName)`
    `long` | `getLastDeath()`
    `int` | `getMaxVaults()`
    `java.util.ArrayList<org.bukkit.entity.Player>` | `getOnlinePlayers()`
    `boolean` | `getOpen()`
    `java.util.Set<java.lang.String>` | `getOwnerList(FLocation loc)`
    `java.lang.String` | `getOwnerListString(FLocation loc)`
    `java.lang.String` | `getPaypal()`
    `boolean` | `getPeacefulExplosionsEnabled()`
    `java.lang.Integer` | `getPermanentPower()`
    `java.util.Map<Permissable,java.util.Map<PermissableAction,Access>>` | `getPermissions()` Read only map of Permissions.
    `double` | `getPower()`
    `double` | `getPowerBoost()`
    `double` | `getPowerMax()`
    `int` | `getPowerMaxRounded()`
    `int` | `getPowerRounded()`
    `int` | `getRelationCount(Relation relation)`
    `Relation` | `getRelationTo(RelationParticipator rp)`
    `Relation` | `getRelationTo(RelationParticipator rp, boolean ignorePeaceful)`
    `Relation` | `getRelationWish(Faction otherFaction)`
    `java.lang.String` | `getRule(int index)`
    `java.util.HashMap<java.lang.Integer,java.lang.String>` | `getRulesMap()`
    `int` | `getSize()`
    `java.lang.String` | `getTag()`
    `java.lang.String` | `getTag(Faction otherFaction)`
    `java.lang.String` | `getTag(FPlayer otherFplayer)`
    `java.lang.String` | `getTag(java.lang.String prefix)`
    `int` | `getTnt()`
    `int` | `getUpgrade(java.lang.String key)`
    `org.bukkit.Location` | `getVault()`
    `LazyLocation` | `getWarp(java.lang.String name)`
    `java.util.concurrent.ConcurrentHashMap<java.lang.String,LazyLocation>` | `getWarps()`
    `boolean` | `hasHome()`
    `boolean` | `hasLandInflation()`
    `boolean` | `hasPermanentPower()`
    `boolean` | `hasPlayersOnline()`
    `boolean` | `hasWarpPassword(java.lang.String warp)`
    `void` | `invite(FPlayer fplayer)`
    `boolean` | `isBanned(FPlayer player)`
    `boolean` | `isInvited(FPlayer fplayer)`
    `boolean` | `isNone()`
    `boolean` | `isNormal()`
    `boolean` | `isPeaceful()`
    `boolean` | `isPermanent()`
    `boolean` | `isPlayerFreeType()`
    `boolean` | `isPlayerInOwnerList(FPlayer player, FLocation loc)`
    `boolean` | `isPowerFrozen()`
    `boolean` | `isSafeZone()`
    `boolean` | `isWarp(java.lang.String name)`
    `boolean` | `isWarpPassword(java.lang.String warp, java.lang.String password)`
    `boolean` | `isWarZone()`
    `boolean` | `isWilderness()`
    `void` | `memberLoggedOff()`
    `void` | `msg(java.lang.String message, java.lang.Object... args)`
    `void` | `msg(TL translation, java.lang.Object... args)`
    `boolean` | `noExplosionsInTerritory()`
    `boolean` | `noMonstersInTerritory()`
    `boolean` | `noPvPInTerritory()`
    `void` | `paypalSet(java.lang.String paypal)`
    `boolean` | `playerHasOwnershipRights(FPlayer fplayer, FLocation loc)`
    `void` | `promoteNewLeader()`
    `void` | `refreshFPlayers()`
    `void` | `remove()`
    `void` | `removeAnnouncements(FPlayer fPlayer)`
    `boolean` | `removeFPlayer(FPlayer fplayer)`
    `void` | `removePlayerAsOwner(FPlayer player, FLocation loc)`
    `void` | `removeRule(int index)`
    `boolean` | `removeWarp(java.lang.String name)`
    `void` | `resetPerms()`
    `void` | `sendMessage(java.util.List<java.lang.String> messages)`
    `void` | `sendMessage(java.lang.String message)`
    `void` | `sendUnreadAnnouncements(FPlayer fPlayer)`
    `void` | `setBannerPattern(org.bukkit.inventory.ItemStack banner)`
    `void` | `setCheckpoint(org.bukkit.Location location)`
    `void` | `setChestSize(int chestSize)`
    `void` | `setDefaultRole(Role role)`
    `void` | `setDescription(java.lang.String value)`
    `void` | `setFocused(java.lang.String fp)`
    `void` | `setFoundedDate(long newDate)`
    `void` | `setHome(org.bukkit.Location home)`
    `void` | `setId(java.lang.String id)`
    `void` | `setLastDeath(long time)`
    `void` | `setMaxVaults(int value)`
    `void` | `setOpen(boolean isOpen)`
    `void` | `setPeaceful(boolean isPeaceful)`
    `void` | `setPeacefulExplosionsEnabled(boolean val)`
    `void` | `setPermanent(boolean isPermanent)`
    `void` | `setPermanentPower(java.lang.Integer permanentPower)`
    `void` | `setPermission(Permissable permissable, PermissableAction permissableAction, Access access)`
    `void` | `setPlayerAsOwner(FPlayer player, FLocation loc)`
    `void` | `setPowerBoost(double powerBoost)`
    `void` | `setRelationWish(Faction otherFaction, Relation relation)`
    `void` | `setRule(int index, java.lang.String rule)`
    `void` | `setTag(java.lang.String str)`
    `void` | `setUpgrades(java.lang.String key, int level)`
    `void` | `setVault(org.bukkit.Location vaultLocation)`
    `void` | `setWarp(java.lang.String name, LazyLocation loc)`
    `void` | `setWarpPassword(java.lang.String warp, java.lang.String password)`
    `void` | `takeTnt(int amt)`
    `void` | `unban(FPlayer player)`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### rules

          public java.util.HashMap<java.lang.Integer,java.lang.String> rules

    - #### tnt

          public int tnt

    - #### checkpoint

          public org.bukkit.Location checkpoint

    - #### vault

          public LazyLocation vault

    - #### upgrades

          public java.util.HashMap<java.lang.String,java.lang.Integer> upgrades

    - #### id

          protected java.lang.String id

    - #### peacefulExplosionsEnabled

          protected boolean peacefulExplosionsEnabled

    - #### permanent

          protected boolean permanent

    - #### tag

          protected java.lang.String tag

    - #### description

          protected java.lang.String description

    - #### open

          protected boolean open

    - #### peaceful

          protected boolean peaceful

    - #### permanentPower

          protected java.lang.Integer permanentPower

    - #### home

          protected LazyLocation home

    - #### foundedDate

          protected long foundedDate

    - #### lastPlayerLoggedOffTime

          protected transient long lastPlayerLoggedOffTime

    - #### money

          protected double money

    - #### powerBoost

          protected double powerBoost

    - #### paypal

          protected java.lang.String paypal

    - #### relationWish

          protected java.util.Map<java.lang.String,Relation> relationWish

    - #### claimOwnership

          protected java.util.Map<FLocation,java.util.Set<java.lang.String>> claimOwnership

    - #### fplayers

          protected transient java.util.Set<FPlayer> fplayers

    - #### invites

          protected java.util.Set<java.lang.String> invites

    - #### announcements

          protected java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> announcements

    - #### warps

          protected java.util.concurrent.ConcurrentHashMap<java.lang.String,LazyLocation> warps

    - #### warpPasswords

          protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String> warpPasswords

    - #### maxVaults

          protected int maxVaults

    - #### defaultRole

          protected Role defaultRole

    - #### permissions

          protected java.util.Map<Permissable,java.util.Map<PermissableAction,Access>> permissions

    - #### bans

          protected java.util.Set<BanInfo> bans

    - #### player

          protected java.lang.String player

  - ### Constructor Detail

    - #### MemoryFaction

          public MemoryFaction()

    - #### MemoryFaction

          public MemoryFaction(java.lang.String id)

    - #### MemoryFaction

          public MemoryFaction(MemoryFaction old)

  - ### Method Detail

    - #### getAnnouncements

          public java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> getAnnouncements()

      Specified by:
        `getAnnouncements` in interface `Faction`

    - #### addAnnouncement

          public void addAnnouncement(FPlayer fPlayer,
                                      java.lang.String msg)

      Specified by:
        `addAnnouncement` in interface `Faction`

    - #### sendUnreadAnnouncements

          public void sendUnreadAnnouncements(FPlayer fPlayer)

      Specified by:
        `sendUnreadAnnouncements` in interface `Faction`

    - #### removeAnnouncements

          public void removeAnnouncements(FPlayer fPlayer)

      Specified by:
        `removeAnnouncements` in interface `Faction`

    - #### getWarps

          public java.util.concurrent.ConcurrentHashMap<java.lang.String,LazyLocation> getWarps()

      Specified by:
        `getWarps` in interface `Faction`

    - #### getWarp

          public LazyLocation getWarp(java.lang.String name)

      Specified by:
        `getWarp` in interface `Faction`

    - #### setWarp

          public void setWarp(java.lang.String name,
                              LazyLocation loc)

      Specified by:
        `setWarp` in interface `Faction`

    - #### isWarp

          public boolean isWarp(java.lang.String name)

      Specified by:
        `isWarp` in interface `Faction`

    - #### removeWarp

          public boolean removeWarp(java.lang.String name)

      Specified by:
        `removeWarp` in interface `Faction`

    - #### isWarpPassword

          public boolean isWarpPassword(java.lang.String warp,
                                        java.lang.String password)

      Specified by:
        `isWarpPassword` in interface `Faction`

    - #### getPaypal

          public java.lang.String getPaypal()

      Specified by:
        `getPaypal` in interface `Faction`

    - #### paypalSet

          public void paypalSet(java.lang.String paypal)

      Specified by:
        `paypalSet` in interface `Faction`

    - #### hasWarpPassword

          public boolean hasWarpPassword(java.lang.String warp)

      Specified by:
        `hasWarpPassword` in interface `Faction`

    - #### setWarpPassword

          public void setWarpPassword(java.lang.String warp,
                                      java.lang.String password)

      Specified by:
        `setWarpPassword` in interface `Faction`

    - #### clearWarps

          public void clearWarps()

      Specified by:
        `clearWarps` in interface `Faction`

    - #### getMaxVaults

          public int getMaxVaults()

      Specified by:
        `getMaxVaults` in interface `Faction`

    - #### setMaxVaults

          public void setMaxVaults(int value)

      Specified by:
        `setMaxVaults` in interface `Faction`

    - #### getFocused

          public java.lang.String getFocused()

      Specified by:
        `getFocused` in interface `Faction`

    - #### setFocused

          public void setFocused(java.lang.String fp)

      Specified by:
        `setFocused` in interface `Faction`

    - #### getInvites

          public java.util.Set<java.lang.String> getInvites()

      Specified by:
        `getInvites` in interface `Faction`

    - #### getId

          public java.lang.String getId()

      Specified by:
        `getId` in interface `Faction`

    - #### setId

          public void setId(java.lang.String id)

      Specified by:
        `setId` in interface `Faction`

    - #### invite

          public void invite(FPlayer fplayer)

      Specified by:
        `invite` in interface `Faction`

    - #### deinvite

          public void deinvite(FPlayer fplayer)

      Specified by:
        `deinvite` in interface `Faction`

    - #### isInvited

          public boolean isInvited(FPlayer fplayer)

      Specified by:
        `isInvited` in interface `Faction`

    - #### ban

          public void ban(FPlayer target,
                          FPlayer banner)

      Specified by:
        `ban` in interface `Faction`

    - #### unban

          public void unban(FPlayer player)

      Specified by:
        `unban` in interface `Faction`

    - #### disband

          public void disband(org.bukkit.entity.Player disbander)

      Specified by:
        `disband` in interface `Faction`

    - #### isBanned

          public boolean isBanned(FPlayer player)

      Specified by:
        `isBanned` in interface `Faction`

    - #### getBannedPlayers

          public java.util.Set<BanInfo> getBannedPlayers()

      Specified by:
        `getBannedPlayers` in interface `Faction`

    - #### getRule

          public java.lang.String getRule(int index)

      Specified by:
        `getRule` in interface `Faction`

    - #### getRulesMap

          public java.util.HashMap<java.lang.Integer,java.lang.String> getRulesMap()

      Specified by:
        `getRulesMap` in interface `Faction`

    - #### setRule

          public void setRule(int index,
                              java.lang.String rule)

      Specified by:
        `setRule` in interface `Faction`

    - #### removeRule

          public void removeRule(int index)

      Specified by:
        `removeRule` in interface `Faction`

    - #### addTnt

          public void addTnt(int amt)

      Specified by:
        `addTnt` in interface `Faction`

    - #### takeTnt

          public void takeTnt(int amt)

      Specified by:
        `takeTnt` in interface `Faction`

    - #### getTnt

          public int getTnt()

      Specified by:
        `getTnt` in interface `Faction`

    - #### getVault

          public org.bukkit.Location getVault()

      Specified by:
        `getVault` in interface `Faction`

    - #### setVault

          public void setVault(org.bukkit.Location vaultLocation)

      Specified by:
        `setVault` in interface `Faction`

    - #### getUpgrade

          public int getUpgrade(java.lang.String key)

      Specified by:
        `getUpgrade` in interface `Faction`

    - #### getChestInventory

          public org.bukkit.inventory.Inventory getChestInventory()

      Specified by:
        `getChestInventory` in interface `Faction`

    - #### setChestSize

          public void setChestSize(int chestSize)

      Specified by:
        `setChestSize` in interface `Faction`

    - #### setBannerPattern

          public void setBannerPattern(org.bukkit.inventory.ItemStack banner)

      Specified by:
        `setBannerPattern` in interface `Faction`

    - #### getBanner

          public org.bukkit.inventory.ItemStack getBanner()

      Specified by:
        `getBanner` in interface `Faction`

    - #### setUpgrades

          public void setUpgrades(java.lang.String key,
                                  int level)

      Specified by:
        `setUpgrades` in interface `Faction`

    - #### getCheckpoint

          public org.bukkit.Location getCheckpoint()

      Specified by:
        `getCheckpoint` in interface `Faction`

    - #### setCheckpoint

          public void setCheckpoint(org.bukkit.Location location)

      Specified by:
        `setCheckpoint` in interface `Faction`

    - #### clearRules

          public void clearRules()

      Specified by:
        `clearRules` in interface `Faction`

    - #### addRule

          public void addRule(java.lang.String rule)

      Specified by:
        `addRule` in interface `Faction`

    - #### getOpen

          public boolean getOpen()

      Specified by:
        `getOpen` in interface `Faction`

    - #### setOpen

          public void setOpen(boolean isOpen)

      Specified by:
        `setOpen` in interface `Faction`

    - #### isPeaceful

          public boolean isPeaceful()

      Specified by:
        `isPeaceful` in interface `Faction`

    - #### setPeaceful

          public void setPeaceful(boolean isPeaceful)

      Specified by:
        `setPeaceful` in interface `Faction`

    - #### getPeacefulExplosionsEnabled

          public boolean getPeacefulExplosionsEnabled()

      Specified by:
        `getPeacefulExplosionsEnabled` in interface `Faction`

    - #### setPeacefulExplosionsEnabled

          public void setPeacefulExplosionsEnabled(boolean val)

      Specified by:
        `setPeacefulExplosionsEnabled` in interface `Faction`

    - #### noExplosionsInTerritory

          public boolean noExplosionsInTerritory()

      Specified by:
        `noExplosionsInTerritory` in interface `Faction`

    - #### isPermanent

          public boolean isPermanent()

      Specified by:
        `isPermanent` in interface `Faction`

    - #### setPermanent

          public void setPermanent(boolean isPermanent)

      Specified by:
        `setPermanent` in interface `Faction`

    - #### getTag

          public java.lang.String getTag()

      Specified by:
        `getTag` in interface `Faction`

    - #### setTag

          public void setTag(java.lang.String str)

      Specified by:
        `setTag` in interface `Faction`

    - #### getTag

          public java.lang.String getTag(java.lang.String prefix)

      Specified by:
        `getTag` in interface `Faction`

    - #### getTag

          public java.lang.String getTag(Faction otherFaction)

      Specified by:
        `getTag` in interface `Faction`

    - #### getTag

          public java.lang.String getTag(FPlayer otherFplayer)

      Specified by:
        `getTag` in interface `Faction`

    - #### getComparisonTag

          public java.lang.String getComparisonTag()

      Specified by:
        `getComparisonTag` in interface `Faction`

    - #### getDescription

          public java.lang.String getDescription()

      Specified by:
        `getDescription` in interface `Faction`

    - #### setDescription

          public void setDescription(java.lang.String value)

      Specified by:
        `setDescription` in interface `Faction`

    - #### hasHome

          public boolean hasHome()

      Specified by:
        `hasHome` in interface `Faction`

    - #### getHome

          public org.bukkit.Location getHome()

      Specified by:
        `getHome` in interface `Faction`

    - #### setHome

          public void setHome(org.bukkit.Location home)

      Specified by:
        `setHome` in interface `Faction`

    - #### getFoundedDate

          public long getFoundedDate()

      Specified by:
        `getFoundedDate` in interface `Faction`

    - #### setFoundedDate

          public void setFoundedDate(long newDate)

      Specified by:
        `setFoundedDate` in interface `Faction`

    - #### confirmValidHome

          public void confirmValidHome()

      Specified by:
        `confirmValidHome` in interface `Faction`

    - #### getAccountId

          public java.lang.String getAccountId()

      Specified by:
        `getAccountId` in interface `Faction`
      Specified by:
        `getAccountId` in interface `EconomyParticipator`

    - #### getPermanentPower

          public java.lang.Integer getPermanentPower()

      Specified by:
        `getPermanentPower` in interface `Faction`

    - #### setPermanentPower

          public void setPermanentPower(java.lang.Integer permanentPower)

      Specified by:
        `setPermanentPower` in interface `Faction`

    - #### hasPermanentPower

          public boolean hasPermanentPower()

      Specified by:
        `hasPermanentPower` in interface `Faction`

    - #### getPowerBoost

          public double getPowerBoost()

      Specified by:
        `getPowerBoost` in interface `Faction`

    - #### setPowerBoost

          public void setPowerBoost(double powerBoost)

      Specified by:
        `setPowerBoost` in interface `Faction`

    - #### isPowerFrozen

          public boolean isPowerFrozen()

      Specified by:
        `isPowerFrozen` in interface `Faction`

    - #### getLastDeath

          public long getLastDeath()

    - #### setLastDeath

          public void setLastDeath(long time)

      Specified by:
        `setLastDeath` in interface `Faction`

    - #### getKills

          public int getKills()

      Specified by:
        `getKills` in interface `Faction`

    - #### getDeaths

          public int getDeaths()

      Specified by:
        `getDeaths` in interface `Faction`

    - #### getAccess

          public Access getAccess(Permissable permissable,
                                  PermissableAction permissableAction)

      Specified by:
        `getAccess` in interface `Faction`

    - #### getAccess

          public Access getAccess(FPlayer player,
                                  PermissableAction permissableAction)

      Get the Access of a player. Will use player's Role if they are a faction member. Otherwise, uses their Relation.
      Specified by:
        `getAccess` in interface `Faction`
      Parameters:
        `player` -
        `permissableAction` -
      Returns:

    - #### setPermission

          public void setPermission(Permissable permissable,
                                    PermissableAction permissableAction,
                                    Access access)

      Specified by:
        `setPermission` in interface `Faction`

    - #### resetPerms

          public void resetPerms()

      Specified by:
        `resetPerms` in interface `Faction`

    - #### getPermissions

          public java.util.Map<Permissable,java.util.Map<PermissableAction,Access>> getPermissions()

      Read only map of Permissions.
      Specified by:
        `getPermissions` in interface `Faction`
      Returns:

    - #### getDefaultRole

          public Role getDefaultRole()

      Specified by:
        `getDefaultRole` in interface `Faction`

    - #### setDefaultRole

          public void setDefaultRole(Role role)

      Specified by:
        `setDefaultRole` in interface `Faction`

    - #### noPvPInTerritory

          public boolean noPvPInTerritory()

      Specified by:
        `noPvPInTerritory` in interface `Faction`

    - #### noMonstersInTerritory

          public boolean noMonstersInTerritory()

      Specified by:
        `noMonstersInTerritory` in interface `Faction`

    - #### isNormal

          public boolean isNormal()

      Specified by:
        `isNormal` in interface `Faction`

    - #### isNone

          public boolean isNone()

      Specified by:
        `isNone` in interface `Faction`

    - #### isWilderness

          public boolean isWilderness()

      Specified by:
        `isWilderness` in interface `Faction`

    - #### isSafeZone

          public boolean isSafeZone()

      Specified by:
        `isSafeZone` in interface `Faction`

    - #### isWarZone

          public boolean isWarZone()

      Specified by:
        `isWarZone` in interface `Faction`

    - #### isPlayerFreeType

          public boolean isPlayerFreeType()

      Specified by:
        `isPlayerFreeType` in interface `Faction`

    - #### describeTo

          public java.lang.String describeTo(RelationParticipator that,
                                             boolean ucfirst)

      Specified by:
        `describeTo` in interface `Faction`
      Specified by:
        `describeTo` in interface `RelationParticipator`

    - #### describeTo

          public java.lang.String describeTo(RelationParticipator that)

      Specified by:
        `describeTo` in interface `Faction`
      Specified by:
        `describeTo` in interface `RelationParticipator`

    - #### getRelationTo

          public Relation getRelationTo(RelationParticipator rp)

      Specified by:
        `getRelationTo` in interface `Faction`
      Specified by:
        `getRelationTo` in interface `RelationParticipator`

    - #### getRelationTo

          public Relation getRelationTo(RelationParticipator rp,
                                        boolean ignorePeaceful)

      Specified by:
        `getRelationTo` in interface `Faction`
      Specified by:
        `getRelationTo` in interface `RelationParticipator`

    - #### getColorTo

          public org.bukkit.ChatColor getColorTo(RelationParticipator rp)

      Specified by:
        `getColorTo` in interface `Faction`
      Specified by:
        `getColorTo` in interface `RelationParticipator`

    - #### getRelationWish

          public Relation getRelationWish(Faction otherFaction)

      Specified by:
        `getRelationWish` in interface `Faction`

    - #### setRelationWish

          public void setRelationWish(Faction otherFaction,
                                      Relation relation)

      Specified by:
        `setRelationWish` in interface `Faction`

    - #### getRelationCount

          public int getRelationCount(Relation relation)

      Specified by:
        `getRelationCount` in interface `Faction`

    - #### getPower

          public double getPower()

      Specified by:
        `getPower` in interface `Faction`

    - #### getPowerMax

          public double getPowerMax()

      Specified by:
        `getPowerMax` in interface `Faction`

    - #### getPowerRounded

          public int getPowerRounded()

      Specified by:
        `getPowerRounded` in interface `Faction`

    - #### getPowerMaxRounded

          public int getPowerMaxRounded()

      Specified by:
        `getPowerMaxRounded` in interface `Faction`

    - #### getLandRounded

          public int getLandRounded()

      Specified by:
        `getLandRounded` in interface `Faction`

    - #### getLandRoundedInWorld

          public int getLandRoundedInWorld(java.lang.String worldName)

      Specified by:
        `getLandRoundedInWorld` in interface `Faction`

    - #### hasLandInflation

          public boolean hasLandInflation()

      Specified by:
        `hasLandInflation` in interface `Faction`

    - #### refreshFPlayers

          public void refreshFPlayers()

      Specified by:
        `refreshFPlayers` in interface `Faction`

    - #### addFPlayer

          public boolean addFPlayer(FPlayer fplayer)

      Specified by:
        `addFPlayer` in interface `Faction`

    - #### removeFPlayer

          public boolean removeFPlayer(FPlayer fplayer)

      Specified by:
        `removeFPlayer` in interface `Faction`

    - #### getSize

          public int getSize()

      Specified by:
        `getSize` in interface `Faction`

    - #### getFPlayers

          public java.util.Set<FPlayer> getFPlayers()

      Specified by:
        `getFPlayers` in interface `Faction`

    - #### getFPlayersWhereOnline

          public java.util.Set<FPlayer> getFPlayersWhereOnline(boolean online)

      Specified by:
        `getFPlayersWhereOnline` in interface `Faction`

    - #### getFPlayersWhereOnline

          public java.util.Set<FPlayer> getFPlayersWhereOnline(boolean online,
                                                               FPlayer viewer)

      Specified by:
        `getFPlayersWhereOnline` in interface `Faction`

    - #### getFPlayerAdmin

          public FPlayer getFPlayerAdmin()

      Specified by:
        `getFPlayerAdmin` in interface `Faction`

    - #### getFPlayersWhereRole

          public java.util.ArrayList<FPlayer> getFPlayersWhereRole(Role role)

      Specified by:
        `getFPlayersWhereRole` in interface `Faction`

    - #### getOnlinePlayers

          public java.util.ArrayList<org.bukkit.entity.Player> getOnlinePlayers()

      Specified by:
        `getOnlinePlayers` in interface `Faction`

    - #### hasPlayersOnline

          public boolean hasPlayersOnline()

      Specified by:
        `hasPlayersOnline` in interface `Faction`

    - #### memberLoggedOff

          public void memberLoggedOff()

      Specified by:
        `memberLoggedOff` in interface `Faction`

    - #### promoteNewLeader

          public void promoteNewLeader()

      Specified by:
        `promoteNewLeader` in interface `Faction`

    - #### msg

          public void msg(java.lang.String message,
                          java.lang.Object... args)

      Specified by:
        `msg` in interface `Faction`
      Specified by:
        `msg` in interface `EconomyParticipator`

    - #### msg

          public void msg(TL translation,
                          java.lang.Object... args)

      Specified by:
        `msg` in interface `EconomyParticipator`

    - #### sendMessage

          public void sendMessage(java.lang.String message)

      Specified by:
        `sendMessage` in interface `Faction`

    - #### sendMessage

          public void sendMessage(java.util.List<java.lang.String> messages)

      Specified by:
        `sendMessage` in interface `Faction`

    - #### getClaimOwnership

          public java.util.Map<FLocation,java.util.Set<java.lang.String>> getClaimOwnership()

      Specified by:
        `getClaimOwnership` in interface `Faction`

    - #### clearAllClaimOwnership

          public void clearAllClaimOwnership()

      Specified by:
        `clearAllClaimOwnership` in interface `Faction`

    - #### clearClaimOwnership

          public void clearClaimOwnership(FLocation loc)

      Specified by:
        `clearClaimOwnership` in interface `Faction`

    - #### clearClaimOwnership

          public void clearClaimOwnership(FPlayer player)

      Specified by:
        `clearClaimOwnership` in interface `Faction`

    - #### getCountOfClaimsWithOwners

          public int getCountOfClaimsWithOwners()

      Specified by:
        `getCountOfClaimsWithOwners` in interface `Faction`

    - #### doesLocationHaveOwnersSet

          public boolean doesLocationHaveOwnersSet(FLocation loc)

      Specified by:
        `doesLocationHaveOwnersSet` in interface `Faction`

    - #### isPlayerInOwnerList

          public boolean isPlayerInOwnerList(FPlayer player,
                                             FLocation loc)

      Specified by:
        `isPlayerInOwnerList` in interface `Faction`

    - #### setPlayerAsOwner

          public void setPlayerAsOwner(FPlayer player,
                                       FLocation loc)

      Specified by:
        `setPlayerAsOwner` in interface `Faction`

    - #### removePlayerAsOwner

          public void removePlayerAsOwner(FPlayer player,
                                          FLocation loc)

      Specified by:
        `removePlayerAsOwner` in interface `Faction`

    - #### getOwnerList

          public java.util.Set<java.lang.String> getOwnerList(FLocation loc)

      Specified by:
        `getOwnerList` in interface `Faction`

    - #### getOwnerListString

          public java.lang.String getOwnerListString(FLocation loc)

      Specified by:
        `getOwnerListString` in interface `Faction`

    - #### playerHasOwnershipRights

          public boolean playerHasOwnershipRights(FPlayer fplayer,
                                                  FLocation loc)

      Specified by:
        `playerHasOwnershipRights` in interface `Faction`

    - #### remove

          public void remove()

      Specified by:
        `remove` in interface `Faction`

    - #### getAllClaims

          public java.util.Set<FLocation> getAllClaims()

      Specified by:
        `getAllClaims` in interface `Faction`