me.leoko.advancedban.manager

Class MessageManager

java.lang.Object

me.leoko.advancedban.manager.MessageManager

public class MessageManager
extends Object

The Message Manager is used for a convenient way to retrieve messages from configuration files.
The manager is designed for (but not limited to) messages from the message.yml file.

Constructor Summary

Constructors

Constructor and Description
MessageManager()

Method Summary

Modifier and Type	Method and Description
static List<String>	getLayout(Object file, String path, String... parameters) Get the layout (basically just a string list) from the given path in the given file. The parameters work as described in sendMessage(Object, String, boolean, String...).
static String	getMessage(String path, boolean prefix, String... parameters) Get the message from the given path. The parameters work as described in sendMessage(Object, String, boolean, String...).
static String	getMessage(String path, String... parameters) Get the message from the given path. The parameters work as described in sendMessage(Object, String, boolean, String...).
static void	sendMessage(Object receiver, String path, boolean prefix, String... parameters) Send message from the given path directly to the given receiver. How the parameters work: The amount of parameters given has to be an even number as the parameters are interpreted in pairs. The first parameter is the String to search for and the second one is the one it will be replaced with. Same goes for the third and fourth and for the fifth and sixth and so on. e.g.: getMessage("some.path", "NAME", "Leoko", "ID", "#342") will get the message located at "some.path" and replace each %NAME% with Leoko and each %ID% with #342.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageManager

public MessageManager()

Method Detail

getMessage

public static String getMessage(String path,
                                String... parameters)

Get the message from the given path.
The parameters work as described in sendMessage(Object, String, boolean, String...).

Parameters:

path - the path

parameters - the parameters

Returns:

the message

getMessage

public static String getMessage(String path,
                                boolean prefix,
                                String... parameters)

Get the message from the given path.
The parameters work as described in sendMessage(Object, String, boolean, String...).

Parameters:

path - the path

prefix - whether to prepend a prefix (can be overridden by the DisablePrefix option)

parameters - the parameters

Returns:

the message

getLayout

public static List<String> getLayout(Object file,
                                     String path,
                                     String... parameters)

Get the layout (basically just a string list) from the given path in the given file.
The parameters work as described in sendMessage(Object, String, boolean, String...).

Parameters:

file - the file (see MethodInterface.getConfig(), MethodInterface.getMessages(), MethodInterface.getLayouts())

path - the path

parameters - the parameters

Returns:

the layout

sendMessage

public static void sendMessage(Object receiver,
                               String path,
                               boolean prefix,
                               String... parameters)

Send message from the given path directly to the given receiver.

How the parameters work: The amount of parameters given has to be an even number as the parameters are interpreted in pairs.
The first parameter is the String to search for and the second one is the one it will be replaced with.
Same goes for the third and fourth and for the fifth and sixth and so on.

e.g.: getMessage("some.path", "NAME", "Leoko", "ID", "#342") will get the message located at "some.path" and replace each %NAME% with Leoko and each %ID% with #342.

Parameters:

receiver - the receiver (Bukkit or Bungeecord player object)

path - the path

prefix - whether to use the global prefix

parameters - the parameters