Package xyz.srnyx.annoyingapi.message

Class AnnoyingMessage

java.lang.Object

xyz.srnyx.javautilities.parents.Stringable

xyz.srnyx.annoyingapi.message.AnnoyingMessage

public class AnnoyingMessage
extends xyz.srnyx.javautilities.parents.Stringable

Represents a message from the MessagesOptions.fileName file

Constructor Summary

Constructors

Constructor	Description
AnnoyingMessage(@NotNull AnnoyingPlugin plugin, @NotNull String key)	Constructs a new AnnoyingMessage with the specified key and PAPI placeholders enabled
AnnoyingMessage(@NotNull AnnoyingPlugin plugin, @NotNull String key, boolean parsePapiPlaceholders)	Constructs a new AnnoyingMessage with the specified key
AnnoyingMessage(@NotNull AnnoyingMessage message)	Constructs a new AnnoyingMessage from another AnnoyingMessage (copy constructor)
AnnoyingMessage(@NotNull AnnoyingMessage message, @NotNull String newKey)	Constructs a new AnnoyingMessage from another AnnoyingMessage with a new key

Method Summary

Modifier and Type	Method	Description
void	broadcast(@NotNull BroadcastType type)	Broadcasts the message with the specified BroadcastType and default title parameters
void	broadcast(@NotNull BroadcastType type, @Nullable Integer fadeIn, @Nullable Integer stay, @Nullable Integer fadeOut)	Broadcasts the message with the specified BroadcastType and title parameters
void	broadcast(@NotNull BroadcastType type, @Nullable AnnoyingSender sender)	Broadcasts the message with the specified BroadcastType, AnnoyingSender, and default title parameters
void	broadcast(@NotNull BroadcastType type, @Nullable AnnoyingSender sender, @Nullable Integer fadeIn, @Nullable Integer stay, @Nullable Integer fadeOut)	Broadcasts the message with the specified BroadcastType and title parameters.
@NotNull net.md_5.bungee.api.chat.BaseComponent[]	getComponents()	Runs getComponents(AnnoyingSender) using null
@NotNull net.md_5.bungee.api.chat.BaseComponent[]	getComponents(@Nullable AnnoyingSender sender)	Gets the message in BaseComponents
void	log()	Runs log(Level) using null
void	log(@Nullable Level level)	Logs the message to the console with the specified Level
@NotNull AnnoyingMessage	replace(@NotNull String before, @Nullable Object after)	Replace a String in the message with another Object
@NotNull AnnoyingMessage	replace(@NotNull String placeholder, @Nullable Object value, @Nullable ReplaceType type)	replace(String, Object) except using parameter placeholders
void	send(@NotNull org.bukkit.command.CommandSender sender)	Sends the message to the specified CommandSender
void	send(@NotNull AnnoyingSender sender)	Sends the message to the specified AnnoyingSender
@NotNull String	toString()	Runs toString(AnnoyingSender) using null
@NotNull String	toString(@Nullable AnnoyingSender sender)	Gets the message using getComponents(AnnoyingSender) then joins the BaseComponents together

Methods inherited from class xyz.srnyx.javautilities.parents.Stringable

toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AnnoyingMessage

public AnnoyingMessage(@NotNull
 @NotNull AnnoyingPlugin plugin,
 @NotNull
 @NotNull String key,
 boolean parsePapiPlaceholders)

Constructs a new AnnoyingMessage with the specified key

Parameters:

plugin - plugin

key - key

parsePapiPlaceholders - parsePapiPlaceholders

AnnoyingMessage

public AnnoyingMessage(@NotNull
 @NotNull AnnoyingPlugin plugin,
 @NotNull
 @NotNull String key)

Constructs a new AnnoyingMessage with the specified key and PAPI placeholders enabled

Parameters:

plugin - plugin

key - key

AnnoyingMessage

public AnnoyingMessage(@NotNull
 @NotNull AnnoyingMessage message)

Constructs a new AnnoyingMessage from another AnnoyingMessage (copy constructor)

Parameters:

message - the AnnoyingMessage to copy

AnnoyingMessage

public AnnoyingMessage(@NotNull
 @NotNull AnnoyingMessage message,
 @NotNull
 @NotNull String newKey)

Constructs a new AnnoyingMessage from another AnnoyingMessage with a new key

Parameters:

message - the AnnoyingMessage to copy

newKey - the new key to use

Method Details

replace

@NotNull
public @NotNull AnnoyingMessage replace(@NotNull
 @NotNull String placeholder,
 @Nullable
 @Nullable Object value,
 @Nullable
 @Nullable ReplaceType type)

replace(String, Object) except using parameter placeholders

Parameters:

placeholder - the placeholder to replace (must have % on both sides)

value - the Object to replace with

type - the DefaultReplaceType to use. If null, the replacement will be treated normally

Returns:

the updated AnnoyingMessage instance

See Also:

• replace(String, Object)
• ReplaceType

replace

@NotNull
public @NotNull AnnoyingMessage replace(@NotNull
 @NotNull String before,
 @Nullable
 @Nullable Object after)

Replace a String in the message with another Object

Parameters:

before - the String to replace

after - the Object to replace with

Returns:

the updated AnnoyingMessage instance

See Also:

• replace(String, Object, xyz.srnyx.annoyingapi.message.ReplaceType)

getComponents

@NotNull
public @NotNull net.md_5.bungee.api.chat.BaseComponent[] getComponents(@Nullable
 @Nullable AnnoyingSender sender)

Gets the message in BaseComponents

Parameters:

sender - the AnnoyingSender to use

Returns:

the message in BaseComponents

See Also:

• send(AnnoyingSender)

getComponents

@NotNull
public @NotNull net.md_5.bungee.api.chat.BaseComponent[] getComponents()

Runs getComponents(AnnoyingSender) using null

Returns:

the message in BaseComponents

See Also:

• send(AnnoyingSender)
• getComponents(AnnoyingSender)

toString

@NotNull
public @NotNull String toString(@Nullable
 @Nullable AnnoyingSender sender)

Gets the message using getComponents(AnnoyingSender) then joins the BaseComponents together

This will only have the display text of the components, use getComponents(AnnoyingSender) for all parts

Parameters:

sender - the AnnoyingSender to use

Returns:

the message

See Also:

• getComponents(AnnoyingSender)

toString

@NotNull
public @NotNull String toString()

Runs toString(AnnoyingSender) using null

This will only have the display text of the components, use getComponents() for all parts

Overrides:

toString in class xyz.srnyx.javautilities.parents.Stringable

Returns:

the message

See Also:

• getComponents()
• toString(AnnoyingSender)

broadcast

public void broadcast(@NotNull
 @NotNull BroadcastType type,
 @Nullable
 @Nullable AnnoyingSender sender,
 @Nullable
 @Nullable Integer fadeIn,
 @Nullable
 @Nullable Integer stay,
 @Nullable
 @Nullable Integer fadeOut)

Broadcasts the message with the specified BroadcastType and title parameters. fadeIn, stay, and fadeOut are 1.11+ only and will be ignored on older versions

Parameters:

type - the BroadcastType to broadcast with

sender - the AnnoyingSender to use

fadeIn - the fade in time for the title

stay - the stay time for the title

fadeOut - the fade out time for the title

See Also:

• broadcast(BroadcastType, Integer, Integer, Integer)
• broadcast(BroadcastType, AnnoyingSender)
• broadcast(BroadcastType)

broadcast

public void broadcast(@NotNull
 @NotNull BroadcastType type,
 @Nullable
 @Nullable Integer fadeIn,
 @Nullable
 @Nullable Integer stay,
 @Nullable
 @Nullable Integer fadeOut)

Broadcasts the message with the specified BroadcastType and title parameters

This is equivalent to calling broadcast(BroadcastType, AnnoyingSender, Integer, Integer, Integer) with null for sender

Parameters:

type - the BroadcastType to broadcast with

fadeIn - the fade in time for the title

stay - the stay time for the title

fadeOut - the fade out time for the title

See Also:

• broadcast(BroadcastType, AnnoyingSender, Integer, Integer, Integer)

broadcast

public void broadcast(@NotNull
 @NotNull BroadcastType type,
 @Nullable
 @Nullable AnnoyingSender sender)

Broadcasts the message with the specified BroadcastType, AnnoyingSender, and default title parameters

This is equivalent to calling broadcast(BroadcastType, AnnoyingSender, Integer, Integer, Integer) with null for all title parameters

Parameters:

type - the BroadcastType to broadcast with

sender - the AnnoyingSender to use

See Also:

• broadcast(BroadcastType, AnnoyingSender, Integer, Integer, Integer)

broadcast

public void broadcast(@NotNull
 @NotNull BroadcastType type)

Broadcasts the message with the specified BroadcastType and default title parameters

This is equivalent to calling broadcast(BroadcastType, AnnoyingSender, Integer, Integer, Integer) with null for all other parameters

Parameters:

type - the BroadcastType to broadcast with

See Also:

• broadcast(BroadcastType, AnnoyingSender, Integer, Integer, Integer)

send

public void send(@NotNull
 @NotNull AnnoyingSender sender)

Sends the message to the specified AnnoyingSender

Parameters:

sender - the AnnoyingSender to send the message to

See Also:

• send(CommandSender)
• getComponents(AnnoyingSender)

send

public void send(@NotNull
 @NotNull org.bukkit.command.CommandSender sender)

Sends the message to the specified CommandSender

This will convert the CommandSender to a AnnoyingSender and then run send(AnnoyingSender)

Parameters:

sender - the CommandSender to send the message to

See Also:

• send(AnnoyingSender)

log

public void log(@Nullable
 @Nullable Level level)

Logs the message to the console with the specified Level

Parameters:

level - the Level to log with

log

public void log()

Runs log(Level) using null