MessageSender (BeansLib 1.4-SNAPSHOT-108 API)

java.lang.Object
- me.croabeast.beanslib.message.MessageSender

All Implemented Interfaces:: Cloneable

public final class MessageSender
extends Object
implements Cloneable

The MessageSender class represents the action to display a list of messages to a player using MessageExecutor instances for parse different message types and format every message type respectively.

 
 // Creating an instance
 MessageSender sender = new MessageSender(
       Bukkit.getOnlinePlayers(), // can be single or null
       Bukkit.getPlayer("Markiplier")
 );

 // only chat and bossbar messages are allowed with
 // these flags, this is optional
 sender.setFlags(MessageFlag.CHAT, MessageFlag.BOSSBAR);

 // send multiple lists and arrays using the same instance
 sender.send(false, plugin.getConfig().getStringList("path"));

 sender.send(false,
      "[C] <R:1>My message goes here, it's colorful</R>",
      "[BOSSBAR] Look, a bossbar message :o"
 );

Also, this objects implements the Cloneable interface to allow cloning an instance, instead of creating new instances separately.

See send(List) and/or send(String...) for more info.

Since:: 1.3
Author:: CroaBeast

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MessageSender.KeyValue<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageSender.KeyValue<T>`

Constructor Summary

Constructors
Constructor and Description
`MessageSender()` Creates a new sender without any argument defined.
`MessageSender(Collection<? extends org.bukkit.command.CommandSender> targets, org.bukkit.entity.Player parser)` Creates a new sender with a defined collection of targets and a player that parses messages.
`MessageSender(org.bukkit.command.CommandSender sender)` Creates a new sender with a defined target, and if that sender is a player, will act as the parser.
`MessageSender(MessageSender sender)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessageSender`	`addFunctions(java.util.function.BiFunction<org.bukkit.entity.Player,String,String>... functions)` Adds new player-string functions to apply them in every string of the list in `send(List)`.
`MessageSender`	`addFunctions(java.util.function.UnaryOperator<String>... ops)` Adds new string operators to apply them in every string of the list in `send(List)`.
`<T> MessageSender`	`addKeysValues(String[] keys, T... values)`
`<T> MessageSender`	`addKeyValue(MessageSender.KeyValue<T> keyValue)`
`<T> MessageSender`	`addKeyValue(String key, T value)`
`<T> MessageSender`	`addKeyValue(java.util.function.Supplier<MessageSender.KeyValue<T>> supplier)`
`@NotNull MessageSender`	`clone()` Creates and returns a copy of this sender.
`static @NotNull MessageSender`	`fromLoaded()` Returns a clone of the loaded static MessageSender instance.
`static <T> MessageSender.KeyValue<T>`	`newKeyValue(String key, T value)`
`boolean`	`send(List<String> stringList)` Sends a string list to the defined targets of the sender.
`boolean`	`send(String... strings)` Sends a string array to the defined targets of the sender.
`MessageSender`	`setFlags(MessageFlag... flags)` Sets the flags of the displayer to allow certain type of messages.
`MessageSender`	`setKeys(String... keys)` Sets the string keys to be replaced for the input values.
`static void`	`setLoaded(MessageSender sender)` Sets the loaded static MessageSender instance with a new sender.
`MessageSender`	`setTargets(Collection<? extends org.bukkit.command.CommandSender> targets)` The collection or array of targets that messages will be sent.
`MessageSender`	`setTargets(org.bukkit.command.CommandSender... targets)` The collection or array of targets that messages will be sent.
`<T> MessageSender`	`setValues(T... values)` Sets the string values that replaces the input keys with any kind of object.
`boolean`	`singleSend(String string)` Sends an input string to the defined targets of the sender.

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

- Constructor Detail
  - MessageSender
```
public MessageSender(Collection<? extends org.bukkit.command.CommandSender> targets,
                     org.bukkit.entity.Player parser)
```
    Creates a new sender with a defined collection of targets and a player that parses messages.
    
    Parameters:
    
    targets - a collection of targets
    
    parser - a player to parse messages
  - MessageSender
```
public MessageSender(org.bukkit.command.CommandSender sender)
```
    Creates a new sender with a defined target, and if that sender is a player, will act as the parser.
    
    Parameters:
    
    sender - a sender
  - MessageSender
```
public MessageSender()
```
    Creates a new sender without any argument defined. It's recommended to define the targets, parser, keys, values and other parameters before sending a list or array.
  - MessageSender
```
public MessageSender(MessageSender sender)
```
- Method Detail
  - setTargets
```
public MessageSender setTargets(Collection<? extends org.bukkit.command.CommandSender> targets)
```
    The collection or array of targets that messages will be sent. If empty or null, the output will be on the console.
    
    Parameters:
    
    targets - a collection of targets
    
    Returns:
    
    a reference of this object
  - setTargets
```
public MessageSender setTargets(org.bukkit.command.CommandSender... targets)
```
    The collection or array of targets that messages will be sent. If null, the output will be on the console.
    
    Parameters:
    
    targets - an array of targets
    
    Returns:
    
    a reference of this object
  - addFunctions
```
@SafeVarargs
public final MessageSender addFunctions(java.util.function.BiFunction<org.bukkit.entity.Player,String,String>... functions)
```
    Adds new player-string functions to apply them in every string of the list in send(List).
    
    Parameters:
    
    functions - an array of functions
    
    Returns:
    
    a reference of this object
  - addFunctions
```
@SafeVarargs
public final MessageSender addFunctions(java.util.function.UnaryOperator<String>... ops)
```
    Adds new string operators to apply them in every string of the list in send(List).
    
    Parameters:
    
    ops - an array of operators
    
    Returns:
    
    a reference of this object
  - setFlags
```
public MessageSender setFlags(MessageFlag... flags)
```
    Sets the flags of the displayer to allow certain type of messages.
    Not invoking this method or invoking it without any arguments, it will imply that all messages types are allowed.
    
    Parameters:
    
    flags - an array of flags
    
    Returns:
    
    a reference of this object
  - addKeyValue
```
public <T> MessageSender addKeyValue(MessageSender.KeyValue<T> keyValue)
```
  - addKeyValue
```
public <T> MessageSender addKeyValue(java.util.function.Supplier<MessageSender.KeyValue<T>> supplier)
```
  - addKeyValue
```
public <T> MessageSender addKeyValue(String key,
                                     T value)
```
  - addKeysValues
```
@SafeVarargs
public final <T> MessageSender addKeysValues(String[] keys,
                                                           T... values)
```
  - setKeys
```
public MessageSender setKeys(String... keys)
```
    Sets the string keys to be replaced for the input values.
    
    Parameters:
    
    keys - an array of keys
    
    Returns:
    
    a reference of this object
  - setValues
```
@SafeVarargs
public final <T> MessageSender setValues(T... values)
```
    Sets the string values that replaces the input keys with any kind of object.
    Can detect players and entities to get its names.
    
    Type Parameters:
    
    T - the clazz of any given value
    
    Parameters:
    
    values - an array of values to be replaced
    
    Returns:
    
    a reference of this object
  - singleSend
```
public boolean singleSend(String string)
```
    Sends an input string to the defined targets of the sender.
    
    Parameters:
    
    string - an input string to send
    
    Returns:
    
    true if the string was sent, false otherwise
  - send
```
public boolean send(List<String> stringList)
```
    Sends a string list to the defined targets of the sender.
    If the list is empty, null or contains only one string and that string is blank/empty, it will not be sent.
    
    Parameters:
    
    stringList - a string list to send
    
    Returns:
    
    true if the list was sent, false otherwise
  - send
```
public boolean send(String... strings)
```
    Sends a string array to the defined targets of the sender.
    If the array is empty, null or contains only one string and that string is blank/empty, it will not be sent.
    
    Parameters:
    
    strings - a string array to send
    
    Returns:
    
    true if the list was sent, false otherwise
  - clone
```
@NotNull
public @NotNull MessageSender clone()
```
    Creates and returns a copy of this sender.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of this instance
  - setLoaded
```
public static void setLoaded(MessageSender sender)
```
    Sets the loaded static MessageSender instance with a new sender.
    
    Parameters:
    
    sender - a sender
    
    Throws:
    
    NullPointerException - if sender is null
  - fromLoaded
```
@NotNull
public static @NotNull MessageSender fromLoaded()
```
    Returns a clone of the loaded static MessageSender instance.
    
    Returns:
    
    a clone of the static instance
  - newKeyValue
```
public static <T> MessageSender.KeyValue<T> newKeyValue(String key,
                                                        T value)
```

Class MessageSender

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageSender

MessageSender

MessageSender

MessageSender

Method Detail

setTargets

setTargets

addFunctions

addFunctions

setFlags

addKeyValue

addKeyValue

addKeyValue

addKeysValues

setKeys

setValues

singleSend

send

send

clone

setLoaded

fromLoaded

newKeyValue