me.leoko.advancedban

Interface MethodInterface

All Known Implementing Classes:

BukkitMethods, BungeeMethods

public interface MethodInterface

The Method Interface is used to define universal actions which are dependent on the server software used.

Method Summary

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.
Object	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.
Object	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.
Object	getMessages() Get the messages.yml file
Object	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.
Object[]	getOnlinePlayers() Get online players.
Object	getPlayer(String name) Get online player by name.
Object	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.

Method Detail

loadFiles

void loadFiles()

Creates and load the different configuration files.

getFromUrlJson

String getFromUrlJson(String url,
                      String key)

Request JSON from the url and extract the key

Parameters:

url - the url

key - the key

Returns:

the value corresponding to the key

getVersion

String getVersion()

Get the advanced ban version.

Returns:

the version

getKeys

String[] getKeys(Object file,
                 String path)

Get key from a config file at a path.

Parameters:

file - the file

path - the path

Returns:

the string [ ]

getConfig

Object getConfig()

Get the config.yml file

Returns:

the config

getMessages

Object getMessages()

Get the messages.yml file

Returns:

the messages

getLayouts

Object getLayouts()

Get the layouts.yml file

Returns:

the layouts

setupMetrics

void setupMetrics()

Set up metrics.

getPlugin

Object getPlugin()

Get the plugin instance.

Returns:

the plugin

getDataFolder

File getDataFolder()

Get the data folder for string punishments.

Returns:

the data folder

setCommandExecutor

void setCommandExecutor(String cmd)

Register a command name to be handled by advancedban.

Parameters:

cmd - the cmd

sendMessage

void sendMessage(Object player,
                 String msg)

Send a message to a specific player.

Parameters:

player - the player

msg - the msg

getName

String getName(Object player)

Get a players name.

Parameters:

player - the player

Returns:

the name

getName

String getName(String uuid)

Get a players name based on the intern uuid fetcher.

Parameters:

uuid - the uuid

Returns:

the name

getIP

String getIP(Object player)

Get a players ip.

Parameters:

player - the player

Returns:

the ip

getInternUUID

String getInternUUID(Object player)

Get a players uuid based on the intern uuid fetcher.

Parameters:

player - the player

Returns:

the intern uuid

getInternUUID

String getInternUUID(String player)

Get a players uuid based on the intern uuid fetcher.

Parameters:

player - the player

Returns:

the intern uuid

hasPerms

boolean hasPerms(Object player,
                 String perms)

Check if player has the given permission.

Parameters:

player - the player

perms - the perms

Returns:

the boolean

isOnline

boolean isOnline(String name)

Check whether player is online.

Parameters:

name - the name

Returns:

the boolean

getPlayer

Object getPlayer(String name)

Get online player by name.

Parameters:

name - the name

Returns:

the player

kickPlayer

void kickPlayer(String player,
                String reason)

Kick a player.

Parameters:

player - the player

reason - the reason

getOnlinePlayers

Object[] getOnlinePlayers()

Get online players.

Returns:

the object [ ]

scheduleAsyncRep

void scheduleAsyncRep(Runnable rn,
                      long l1,
                      long l2)

Schedule async repeating task.

Parameters:

rn - the rn

l1 - the l 1

l2 - the l 2

scheduleAsync

void scheduleAsync(Runnable rn,
                   long l1)

Schedule async task.

Parameters:

rn - the rn

l1 - the l 1

runAsync

void runAsync(Runnable rn)

Run async task.

Parameters:

rn - the rn

runSync

void runSync(Runnable rn)

Run sync task.

Parameters:

rn - the rn

executeCommand

void executeCommand(String cmd)

(see implementation)

Parameters:

cmd - the cmd

callChat

boolean callChat(Object player)

(see implementation)

Parameters:

player - the player

Returns:

the boolean

callCMD

boolean callCMD(Object player,
                String cmd)

(see implementation)

Parameters:

player - the player

cmd - the cmd

Returns:

the boolean

loadMySQLFile

void loadMySQLFile(File f)

Load MySQL data from file.

Parameters:

f - the f

createMySQLFile

void createMySQLFile(File f)

Create default MySQL file.

Parameters:

f - the f

getMySQLFile

Object getMySQLFile()

Get MySQL.yml file.

Returns:

the my sql file

parseJSON

String parseJSON(InputStreamReader json,
                 String key)

Parse json string and retrieve value at given key.

Parameters:

json - the json

key - the key

Returns:

the string

parseJSON

String parseJSON(String json,
                 String key)

Parse json string and retrieve value at given key.

Parameters:

json - the json

key - the key

Returns:

the string

getBoolean

Boolean getBoolean(Object file,
                   String path)

Get boolean at the given path from the given file.

Parameters:

file - the file

path - the path

Returns:

the boolean

getString

String getString(Object file,
                 String path)

Get string at the given path from the given file.

Parameters:

file - the file

path - the path

Returns:

the string

getLong

Long getLong(Object file,
             String path)

Get long at the given path from the given file.

Parameters:

file - the file

path - the path

Returns:

the long

getInteger

Integer getInteger(Object file,
                   String path)

Get integer at the given path from the given file.

Parameters:

file - the file

path - the path

Returns:

the integer

getStringList

List<String> getStringList(Object file,
                           String path)

Get string list at the given path from the given file.

Parameters:

file - the file

path - the path

Returns:

the string list

getBoolean

boolean getBoolean(Object file,
                   String path,
                   boolean def)

Get boolean at the given path from the given file or default if not present.

Parameters:

file - the file

path - the path

def - the def

Returns:

the boolean

getString

String getString(Object file,
                 String path,
                 String def)

Get string at the given path from the given file or default if not present.

Parameters:

file - the file

path - the path

def - the def

Returns:

the string

getLong

long getLong(Object file,
             String path,
             long def)

Get long at the given path from the given file or default if not present.

Parameters:

file - the file

path - the path

def - the def

Returns:

the long

getInteger

int getInteger(Object file,
               String path,
               int def)

Get integer at the given path from the given file or default if not present.

Parameters:

file - the file

path - the path

def - the def

Returns:

the integer

contains

boolean contains(Object file,
                 String path)

Check whether file contains given path.

Parameters:

file - the file

path - the path

Returns:

the boolean

getFileName

String getFileName(Object file)

Get file name.

Parameters:

file - the file

Returns:

the file name

callPunishmentEvent

void callPunishmentEvent(Punishment punishment)

Call punishment event.

Parameters:

punishment - the punishment

callRevokePunishmentEvent

void callRevokePunishmentEvent(Punishment punishment,
                               boolean massClear)

Call revoke punishment event.

Parameters:

punishment - the punishment

massClear - the mass clear

isOnlineMode

boolean isOnlineMode()

Check whether server is in online mode. Should indicate whether the intern uuid fetcher is going to work.

Returns:

the boolean

notify

void notify(String perm,
            List<String> notification)

Broadcast a message to every user with the given permission.

Parameters:

perm - the perm

notification - the notification

log

void log(String msg)

Log a message.

Parameters:

msg - the msg

isUnitTesting

boolean isUnitTesting()

Whether this instance is used for unit testing.

Returns:

the boolean