Package com.sk89q.commandbook.component.bans

Interface BanDatabase

All Superinterfaces:
java.lang.Iterable<Ban>
All Known Implementing Classes:
CSVBanDatabase
public interface BanDatabase
extends java.lang.Iterable<Ban>
Interface for a ban database.

  • Method Summary

    Modifier and Type Method Description
    void ban​(java.util.UUID ID, java.lang.String name, java.lang.String address, org.bukkit.command.CommandSender source, java.lang.String reason, long end)
    Bans a UUID and or address.
    void ban​(org.bukkit.entity.Player player, org.bukkit.command.CommandSender source, java.lang.String reason, long end)
    Bans a player by UUID and address.
    Ban getBanned​(java.lang.String address)
    Returns a Ban with the given address
    Ban getBanned​(java.util.UUID ID)
    Returns a Ban with the given UUID
    java.lang.String getBannedMessage​(java.lang.String address)
    Deprecated.
    java.lang.String getBannedMessage​(java.util.UUID ID)
    Deprecated.
    void importFrom​(BanDatabase bans)
    Imports the bans from another ban database.
    boolean isBanned​(java.net.InetAddress address)
    Checks if a player's address is banned.
    boolean isBanned​(java.util.UUID ID)
    Checks if a player's UUID is banned.
    boolean load()
    Load the ban database.
    void logKick​(org.bukkit.entity.Player player, org.bukkit.command.CommandSender source, java.lang.String reason)
    Unbans a name.
    boolean save()
    Save the database.
    boolean unban​(java.util.UUID ID, java.lang.String address, org.bukkit.command.CommandSender source, java.lang.String reason)
    Unban a player and/or address.
    boolean unban​(org.bukkit.entity.Player player, org.bukkit.command.CommandSender source, java.lang.String reason)
    Unban a player by UUID.
    boolean unbanName​(java.lang.String name, org.bukkit.command.CommandSender source, java.lang.String reason)
    Deprecated.
    boolean unload()
    Unloads the database

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator

  • Method Details

    • load

      boolean load()
      Load the ban database.
      Returns:
      whether the operation was fully successful

    • save

      boolean save()
      Save the database.
      Returns:
      whether the operation was fully successful

    • unload

      boolean unload()
      Unloads the database
      Returns:
      whether the operation was fully successful

    • isBanned

      boolean isBanned​(java.util.UUID ID)
      Checks if a player's UUID is banned.
      Parameters:
      ID - The UUID to check
      Returns:
      Whether the UUID is banned

    • isBanned

      boolean isBanned​(java.net.InetAddress address)
      Checks if a player's address is banned.
      Parameters:
      address - The address to check
      Returns:
      Whether the given address is banned

    • getBannedMessage

      @Deprecated java.lang.String getBannedMessage​(java.util.UUID ID)
      Deprecated.
      Gets the ban message for a banned UUID.
      Parameters:
      ID - The ID to check
      Returns:
      The banned message for the given ID

    • getBannedMessage

      @Deprecated java.lang.String getBannedMessage​(java.lang.String address)
      Deprecated.
      Gets the ban message for a banned address.
      Parameters:
      address - The address to check
      Returns:
      The banned message for the given address

    • ban

      void ban​(org.bukkit.entity.Player player, org.bukkit.command.CommandSender source, java.lang.String reason, long end)
      Bans a player by UUID and address.
      Parameters:
      player -
      source -
      reason -
      end -

    • ban

      void ban​(java.util.UUID ID, java.lang.String name, java.lang.String address, org.bukkit.command.CommandSender source, java.lang.String reason, long end)
      Bans a UUID and or address.
      Parameters:
      ID -
      name -
      address -
      source -
      reason -
      end -

    • unbanName

      @Deprecated boolean unbanName​(java.lang.String name, org.bukkit.command.CommandSender source, java.lang.String reason)
      Deprecated.
      Unbans a name. WARNING: This method only works for cases where the UUID for the record is null.
      Parameters:
      name -
      source -
      reason -
      Returns:
      whether the name was found

    • unban

      boolean unban​(org.bukkit.entity.Player player, org.bukkit.command.CommandSender source, java.lang.String reason)
      Unban a player by UUID. WARNING: This method will not unban a player's address
      Parameters:
      player -
      source -
      reason -
      Returns:

    • unban

      boolean unban​(java.util.UUID ID, java.lang.String address, org.bukkit.command.CommandSender source, java.lang.String reason)
      Unban a player and/or address. First looks up by UUID, then if not found looks up by address.
      Parameters:
      ID -
      address -
      source -
      reason -
      Returns:

    • logKick

      void logKick​(org.bukkit.entity.Player player, org.bukkit.command.CommandSender source, java.lang.String reason)
      Unbans a name.
      Parameters:
      player -
      source -
      reason -

    • importFrom

      void importFrom​(BanDatabase bans)
      Imports the bans from another ban database.
      Parameters:
      bans -

    • getBanned

      Ban getBanned​(java.util.UUID ID)
      Returns a Ban with the given UUID
      Parameters:
      ID - The UUID of the banned player.
      Returns:
      The applicable ban

    • getBanned

      Ban getBanned​(java.lang.String address)
      Returns a Ban with the given address
      Parameters:
      address - The address given to the ban.
      Returns:
      The applicable ban