BukkitMethods (AdvancedBan 2.1.7 API)

java.lang.Object
- me.leoko.advancedban.bukkit.BukkitMethods

All Implemented Interfaces:

MethodInterface
```
public class BukkitMethods
extends Object
implements MethodInterface
```
Created by Leoko @ dev.skamps.eu on 23.07.2016.

Constructor Summary

Constructors
Constructor and Description

BukkitMethods()

Constructors
Constructor and Description
`BukkitMethods()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`callChat(Object player)` (see implementation)
`boolean`	`callCMD(Object player, String cmd)` (see implementation)
`void`	`callPunishmentEvent(Punishment punishment)` Call punishment event.
`void`	`callRevokePunishmentEvent(Punishment punishment, boolean massClear)` Call revoke punishment event.
`boolean`	`contains(Object file, String path)` Check whether file contains given path.
`void`	`createMySQLFile(File f)` Create default MySQL file.
`void`	`executeCommand(String cmd)` (see implementation)
`Boolean`	`getBoolean(Object file, String path)` Get boolean at the given path from the given file.
`boolean`	`getBoolean(Object file, String path, boolean def)` Get boolean at the given path from the given file or default if not present.
`YamlConfiguration`	`getConfig()` Get the config.yml file
`File`	`getDataFolder()` Get the data folder for string punishments.
`String`	`getFileName(Object file)` Get file name.
`String`	`getFromUrlJson(String url, String key)` Request JSON from the `url` and extract the `key`
`Integer`	`getInteger(Object file, String path)` Get integer at the given path from the given file.
`int`	`getInteger(Object file, String path, int def)` Get integer at the given path from the given file or default if not present.
`String`	`getInternUUID(Object player)` Get a players uuid based on the intern uuid fetcher.
`String`	`getInternUUID(String player)` Get a players uuid based on the intern uuid fetcher.
`String`	`getIP(Object player)` Get a players ip.
`String[]`	`getKeys(Object file, String path)` Get key from a config file at a `path`.
`YamlConfiguration`	`getLayouts()` Get the layouts.yml file
`Long`	`getLong(Object file, String path)` Get long at the given path from the given file.
`long`	`getLong(Object file, String path, long def)` Get long at the given path from the given file or default if not present.
`YamlConfiguration`	`getMessages()` Get the messages.yml file
`YamlConfiguration`	`getMySQLFile()` Get MySQL.yml file.
`String`	`getName(Object player)` Get a players name.
`String`	`getName(String uuid)` Get a players name based on the intern uuid fetcher.
`Player[]`	`getOnlinePlayers()` Get online players.
`Player`	`getPlayer(String name)` Get online player by name.
`JavaPlugin`	`getPlugin()` Get the plugin instance.
`String`	`getString(Object file, String path)` Get string at the given path from the given file.
`String`	`getString(Object file, String path, String def)` Get string at the given path from the given file or default if not present.
`List<String>`	`getStringList(Object file, String path)` Get string list at the given path from the given file.
`String`	`getVersion()` Get the advanced ban version.
`boolean`	`hasPerms(Object player, String perms)` Check if player has the given permission.
`boolean`	`isOnline(String name)` Check whether player is online.
`boolean`	`isOnlineMode()` Check whether server is in online mode.
`boolean`	`isUnitTesting()` Whether this instance is used for unit testing.
`void`	`kickPlayer(String player, String reason)` Kick a player.
`void`	`loadFiles()` Creates and load the different configuration files.
`void`	`loadMySQLFile(File f)` Load MySQL data from file.
`void`	`log(String msg)` Log a message.
`void`	`notify(String perm, List<String> notification)` Broadcast a message to every user with the given permission.
`String`	`parseJSON(InputStreamReader json, String key)` Parse json string and retrieve value at given key.
`String`	`parseJSON(String json, String key)` Parse json string and retrieve value at given key.
`void`	`runAsync(Runnable rn)` Run async task.
`void`	`runSync(Runnable rn)` Run sync task.
`void`	`scheduleAsync(Runnable rn, long l1)` Schedule async task.
`void`	`scheduleAsyncRep(Runnable rn, long l1, long l2)` Schedule async repeating task.
`void`	`sendMessage(Object player, String msg)` Send a message to a specific player.
`void`	`setCommandExecutor(String cmd)` Register a command name to be handled by advancedban.
`void`	`setupMetrics()` Set up metrics.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BukkitMethods
```
public BukkitMethods()
```
- Method Detail
  - loadFiles
```
public void loadFiles()
```
    Description copied from interface: MethodInterface
    
    Creates and load the different configuration files.
    
    Specified by:
    
    loadFiles in interface MethodInterface
  - getFromUrlJson
```
public String getFromUrlJson(String url,
                             String key)
```
    Description copied from interface: MethodInterface
    
    Request JSON from the url and extract the key
    
    Specified by:
    
    getFromUrlJson in interface MethodInterface
    
    Parameters:
    
    url - the url
    
    key - the key
    
    Returns:
    
    the value corresponding to the key
  - getVersion
```
public String getVersion()
```
    Description copied from interface: MethodInterface
    
    Get the advanced ban version.
    
    Specified by:
    
    getVersion in interface MethodInterface
    
    Returns:
    
    the version
  - getKeys
```
public String[] getKeys(Object file,
                        String path)
```
    Description copied from interface: MethodInterface
    
    Get key from a config file at a path.
    
    Specified by:
    
    getKeys in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    Returns:
    
    the string [ ]
  - getConfig
```
public YamlConfiguration getConfig()
```
    Description copied from interface: MethodInterface
    
    Get the config.yml file
    
    Specified by:
    
    getConfig in interface MethodInterface
    
    Returns:
    
    the config
  - getMessages
```
public YamlConfiguration getMessages()
```
    Description copied from interface: MethodInterface
    
    Get the messages.yml file
    
    Specified by:
    
    getMessages in interface MethodInterface
    
    Returns:
    
    the messages
  - getLayouts
```
public YamlConfiguration getLayouts()
```
    Description copied from interface: MethodInterface
    
    Get the layouts.yml file
    
    Specified by:
    
    getLayouts in interface MethodInterface
    
    Returns:
    
    the layouts
  - setupMetrics
```
public void setupMetrics()
```
    Description copied from interface: MethodInterface
    
    Set up metrics.
    
    Specified by:
    
    setupMetrics in interface MethodInterface
  - getPlugin
```
public JavaPlugin getPlugin()
```
    Description copied from interface: MethodInterface
    
    Get the plugin instance.
    
    Specified by:
    
    getPlugin in interface MethodInterface
    
    Returns:
    
    the plugin
  - getDataFolder
```
public File getDataFolder()
```
    Description copied from interface: MethodInterface
    
    Get the data folder for string punishments.
    
    Specified by:
    
    getDataFolder in interface MethodInterface
    
    Returns:
    
    the data folder
  - setCommandExecutor
```
public void setCommandExecutor(String cmd)
```
    Description copied from interface: MethodInterface
    
    Register a command name to be handled by advancedban.
    
    Specified by:
    
    setCommandExecutor in interface MethodInterface
    
    Parameters:
    
    cmd - the cmd
  - sendMessage
```
public void sendMessage(Object player,
                        String msg)
```
    Description copied from interface: MethodInterface
    
    Send a message to a specific player.
    
    Specified by:
    
    sendMessage in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    msg - the msg
  - hasPerms
```
public boolean hasPerms(Object player,
                        String perms)
```
    Description copied from interface: MethodInterface
    
    Check if player has the given permission.
    
    Specified by:
    
    hasPerms in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    perms - the perms
    
    Returns:
    
    the boolean
  - isOnline
```
public boolean isOnline(String name)
```
    Description copied from interface: MethodInterface
    
    Check whether player is online.
    
    Specified by:
    
    isOnline in interface MethodInterface
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the boolean
  - getPlayer
```
public Player getPlayer(String name)
```
    Description copied from interface: MethodInterface
    
    Get online player by name.
    
    Specified by:
    
    getPlayer in interface MethodInterface
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the player
  - kickPlayer
```
public void kickPlayer(String player,
                       String reason)
```
    Description copied from interface: MethodInterface
    
    Kick a player.
    
    Specified by:
    
    kickPlayer in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    reason - the reason
  - getOnlinePlayers
```
public Player[] getOnlinePlayers()
```
    Description copied from interface: MethodInterface
    
    Get online players.
    
    Specified by:
    
    getOnlinePlayers in interface MethodInterface
    
    Returns:
    
    the object [ ]
  - scheduleAsyncRep
```
public void scheduleAsyncRep(Runnable rn,
                             long l1,
                             long l2)
```
    Description copied from interface: MethodInterface
    
    Schedule async repeating task.
    
    Specified by:
    
    scheduleAsyncRep in interface MethodInterface
    
    Parameters:
    
    rn - the rn
    
    l1 - the l 1
    
    l2 - the l 2
  - scheduleAsync
```
public void scheduleAsync(Runnable rn,
                          long l1)
```
    Description copied from interface: MethodInterface
    
    Schedule async task.
    
    Specified by:
    
    scheduleAsync in interface MethodInterface
    
    Parameters:
    
    rn - the rn
    
    l1 - the l 1
  - runAsync
```
public void runAsync(Runnable rn)
```
    Description copied from interface: MethodInterface
    
    Run async task.
    
    Specified by:
    
    runAsync in interface MethodInterface
    
    Parameters:
    
    rn - the rn
  - runSync
```
public void runSync(Runnable rn)
```
    Description copied from interface: MethodInterface
    
    Run sync task.
    
    Specified by:
    
    runSync in interface MethodInterface
    
    Parameters:
    
    rn - the rn
  - executeCommand
```
public void executeCommand(String cmd)
```
    Description copied from interface: MethodInterface
    
    (see implementation)
    
    Specified by:
    
    executeCommand in interface MethodInterface
    
    Parameters:
    
    cmd - the cmd
  - getName
```
public String getName(Object player)
```
    Description copied from interface: MethodInterface
    
    Get a players name.
    
    Specified by:
    
    getName in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    Returns:
    
    the name
  - getName
```
public String getName(String uuid)
```
    Description copied from interface: MethodInterface
    
    Get a players name based on the intern uuid fetcher.
    
    Specified by:
    
    getName in interface MethodInterface
    
    Parameters:
    
    uuid - the uuid
    
    Returns:
    
    the name
  - getIP
```
public String getIP(Object player)
```
    Description copied from interface: MethodInterface
    
    Get a players ip.
    
    Specified by:
    
    getIP in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    Returns:
    
    the ip
  - getInternUUID
```
public String getInternUUID(Object player)
```
    Description copied from interface: MethodInterface
    
    Get a players uuid based on the intern uuid fetcher.
    
    Specified by:
    
    getInternUUID in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    Returns:
    
    the intern uuid
  - getInternUUID
```
public String getInternUUID(String player)
```
    Description copied from interface: MethodInterface
    
    Get a players uuid based on the intern uuid fetcher.
    
    Specified by:
    
    getInternUUID in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    Returns:
    
    the intern uuid
  - callChat
```
public boolean callChat(Object player)
```
    Description copied from interface: MethodInterface
    
    (see implementation)
    
    Specified by:
    
    callChat in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    Returns:
    
    the boolean
  - callCMD
```
public boolean callCMD(Object player,
                       String cmd)
```
    Description copied from interface: MethodInterface
    
    (see implementation)
    
    Specified by:
    
    callCMD in interface MethodInterface
    
    Parameters:
    
    player - the player
    
    cmd - the cmd
    
    Returns:
    
    the boolean
  - loadMySQLFile
```
public void loadMySQLFile(File f)
```
    Description copied from interface: MethodInterface
    
    Load MySQL data from file.
    
    Specified by:
    
    loadMySQLFile in interface MethodInterface
    
    Parameters:
    
    f - the f
  - createMySQLFile
```
public void createMySQLFile(File f)
```
    Description copied from interface: MethodInterface
    
    Create default MySQL file.
    
    Specified by:
    
    createMySQLFile in interface MethodInterface
    
    Parameters:
    
    f - the f
  - getMySQLFile
```
public YamlConfiguration getMySQLFile()
```
    Description copied from interface: MethodInterface
    
    Get MySQL.yml file.
    
    Specified by:
    
    getMySQLFile in interface MethodInterface
    
    Returns:
    
    the my sql file
  - parseJSON
```
public String parseJSON(InputStreamReader json,
                        String key)
```
    Description copied from interface: MethodInterface
    
    Parse json string and retrieve value at given key.
    
    Specified by:
    
    parseJSON in interface MethodInterface
    
    Parameters:
    
    json - the json
    
    key - the key
    
    Returns:
    
    the string
  - parseJSON
```
public String parseJSON(String json,
                        String key)
```
    Description copied from interface: MethodInterface
    
    Parse json string and retrieve value at given key.
    
    Specified by:
    
    parseJSON in interface MethodInterface
    
    Parameters:
    
    json - the json
    
    key - the key
    
    Returns:
    
    the string
  - getBoolean
```
public Boolean getBoolean(Object file,
                          String path)
```
    Description copied from interface: MethodInterface
    
    Get boolean at the given path from the given file.
    
    Specified by:
    
    getBoolean in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    Returns:
    
    the boolean
  - getString
```
public String getString(Object file,
                        String path)
```
    Description copied from interface: MethodInterface
    
    Get string at the given path from the given file.
    
    Specified by:
    
    getString in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    Returns:
    
    the string
  - getLong
```
public Long getLong(Object file,
                    String path)
```
    Description copied from interface: MethodInterface
    
    Get long at the given path from the given file.
    
    Specified by:
    
    getLong in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    Returns:
    
    the long
  - getInteger
```
public Integer getInteger(Object file,
                          String path)
```
    Description copied from interface: MethodInterface
    
    Get integer at the given path from the given file.
    
    Specified by:
    
    getInteger in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    Returns:
    
    the integer
  - getStringList
```
public List<String> getStringList(Object file,
                                  String path)
```
    Description copied from interface: MethodInterface
    
    Get string list at the given path from the given file.
    
    Specified by:
    
    getStringList in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    Returns:
    
    the string list
  - getBoolean
```
public boolean getBoolean(Object file,
                          String path,
                          boolean def)
```
    Description copied from interface: MethodInterface
    
    Get boolean at the given path from the given file or default if not present.
    
    Specified by:
    
    getBoolean in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    def - the def
    
    Returns:
    
    the boolean
  - getString
```
public String getString(Object file,
                        String path,
                        String def)
```
    Description copied from interface: MethodInterface
    
    Get string at the given path from the given file or default if not present.
    
    Specified by:
    
    getString in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    def - the def
    
    Returns:
    
    the string
  - getLong
```
public long getLong(Object file,
                    String path,
                    long def)
```
    Description copied from interface: MethodInterface
    
    Get long at the given path from the given file or default if not present.
    
    Specified by:
    
    getLong in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    def - the def
    
    Returns:
    
    the long
  - getInteger
```
public int getInteger(Object file,
                      String path,
                      int def)
```
    Description copied from interface: MethodInterface
    
    Get integer at the given path from the given file or default if not present.
    
    Specified by:
    
    getInteger in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    def - the def
    
    Returns:
    
    the integer
  - contains
```
public boolean contains(Object file,
                        String path)
```
    Description copied from interface: MethodInterface
    
    Check whether file contains given path.
    
    Specified by:
    
    contains in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    path - the path
    
    Returns:
    
    the boolean
  - getFileName
```
public String getFileName(Object file)
```
    Description copied from interface: MethodInterface
    
    Get file name.
    
    Specified by:
    
    getFileName in interface MethodInterface
    
    Parameters:
    
    file - the file
    
    Returns:
    
    the file name
  - callPunishmentEvent
```
public void callPunishmentEvent(Punishment punishment)
```
    Description copied from interface: MethodInterface
    
    Call punishment event.
    
    Specified by:
    
    callPunishmentEvent in interface MethodInterface
    
    Parameters:
    
    punishment - the punishment
  - callRevokePunishmentEvent
```
public void callRevokePunishmentEvent(Punishment punishment,
                                      boolean massClear)
```
    Description copied from interface: MethodInterface
    
    Call revoke punishment event.
    
    Specified by:
    
    callRevokePunishmentEvent in interface MethodInterface
    
    Parameters:
    
    punishment - the punishment
    
    massClear - the mass clear
  - isOnlineMode
```
public boolean isOnlineMode()
```
    Description copied from interface: MethodInterface
    
    Check whether server is in online mode. Should indicate whether the intern uuid fetcher is going to work.
    
    Specified by:
    
    isOnlineMode in interface MethodInterface
    
    Returns:
    
    the boolean
  - notify
```
public void notify(String perm,
                   List<String> notification)
```
    Description copied from interface: MethodInterface
    
    Broadcast a message to every user with the given permission.
    
    Specified by:
    
    notify in interface MethodInterface
    
    Parameters:
    
    perm - the perm
    
    notification - the notification
  - log
```
public void log(String msg)
```
    Description copied from interface: MethodInterface
    
    Log a message.
    
    Specified by:
    
    log in interface MethodInterface
    
    Parameters:
    
    msg - the msg
  - isUnitTesting
```
public boolean isUnitTesting()
```
    Description copied from interface: MethodInterface
    
    Whether this instance is used for unit testing.
    
    Specified by:
    
    isUnitTesting in interface MethodInterface
    
    Returns:
    
    the boolean

Class BukkitMethods

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BukkitMethods

Method Detail

loadFiles

getFromUrlJson

getVersion

getKeys

getConfig

getMessages

getLayouts

setupMetrics

getPlugin

getDataFolder

setCommandExecutor

sendMessage

hasPerms

isOnline

getPlayer

kickPlayer

getOnlinePlayers

scheduleAsyncRep

scheduleAsync

runAsync

runSync

executeCommand

getName

getName

getIP

getInternUUID

getInternUUID

callChat

callCMD

loadMySQLFile

createMySQLFile

getMySQLFile

parseJSON

parseJSON

getBoolean

getString

getLong

getInteger

getStringList

getBoolean

getString

getLong

getInteger

contains

getFileName

callPunishmentEvent

callRevokePunishmentEvent

isOnlineMode

notify

log

isUnitTesting