net.amigocraft.mglib.impl

Class BukkitLocalizable

java.lang.Object

net.amigocraft.mglib.impl.BukkitLocalizable

All Implemented Interfaces:

Localizable

Direct Known Subclasses:

CombinedLocalizable

public class BukkitLocalizable
extends java.lang.Object
implements Localizable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BukkitLocalizable()

Method Summary

Modifier and Type	Method and Description
void	broadcast() Broadcasts this message to all players on the server in their respective locales.
void	broadcast(Color color) Broadcasts this message, prefixed by the given color, to all players on the server in their respective locales.
void	broadcast(Color color, java.lang.String... worlds) Broadcasts this message, prefixed by the given color, to all players in the given worlds.
void	broadcast(java.lang.String... worlds) Broadcasts this message to all players in the given worlds.
Localizable	concat(Localizable localizable) Concatenates this Localizable with another into a single new one.
Localizable	concat(Localizable localizable, java.lang.CharSequence separator) Concatenates this Localizable with another into a single new one.
boolean	equals(java.lang.Object otherLocalizable)
java.lang.String	getKey() Gets the key associated with this Localizable.
Locale	getParent() Gets the parent Locale of this message.
java.lang.Object[]	getReplacementSequences() Returns an array of objects which will be used to replace wildcard sequences, in respective order.
int	hashCode()
java.lang.String	localize() Attempts to localize this message based on the server's defined locale.
java.lang.String	localize(java.lang.String locale) Attempts to localize this message in the given locale.
java.lang.String	localizeFor(MGPlayer player) Attempts to localize this message for the given MGPlayer.
java.lang.String	localizeFor(java.lang.String playerName) Attempts to localize this message for the player with the given username.
java.lang.String	localizeFor(java.util.UUID playerUuid) Attempts to localize this message for the player with the given UUID.
void	sendTo(java.lang.String playerName) Attempts to localize this message for the player with the given username and send it to them.
void	sendTo(java.lang.String playerName, Color color) Attempts to localize this message for the player with the given username and send it to them prefixed by the specified chat color.
void	sendTo(java.util.UUID playerUuid) Attempts to localize this message for the player with the given username and send it to them.
void	sendTo(java.util.UUID playerUuid, Color color) Attempts to localize this message for the player with the given UUID and send it to them prefixed by the specified chat color.

Methods inherited from class java.lang.Object

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

Constructor Detail

BukkitLocalizable

protected BukkitLocalizable()

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: Localizable

Gets the key associated with this Localizable.

Specified by:

getKey in interface Localizable

Returns:

The key associated with this Localizable

getParent

public Locale getParent()

Description copied from interface: Localizable

Gets the parent Locale of this message.

Specified by:

getParent in interface Localizable

Returns:

the parent Locale of this message

getReplacementSequences

public java.lang.Object[] getReplacementSequences()

Description copied from interface: Localizable

Returns an array of objects which will be used to replace wildcard sequences, in respective order.

Specified by:

getReplacementSequences in interface Localizable

Returns:

an array of objects which will be used to replace wildcard sequences, in respective order

concat

public Localizable concat(Localizable localizable,
                          java.lang.CharSequence separator)

Description copied from interface: Localizable

Concatenates this Localizable with another into a single new one.

Specified by:

concat in interface Localizable

Parameters:

localizable - The Localizable to concatenate

separator - The string to separate the two Localizables with. If omitted, this will default to a space character.

Returns:

The new combined Localizable

concat

public Localizable concat(Localizable localizable)

Description copied from interface: Localizable

Concatenates this Localizable with another into a single new one.

Specified by:

concat in interface Localizable

Parameters:

localizable - The Localizable to concatenate

Returns:

The new combined Localizable

localize

public java.lang.String localize()

Description copied from interface: Localizable

Attempts to localize this message based on the server's defined locale.

Specified by:

localize in interface Localizable

Returns:

The message localized as requested if possible; otherwise the message localized in the default locale if possible; otherwise the raw localization key

localize

public java.lang.String localize(java.lang.String locale)

Description copied from interface: Localizable

Attempts to localize this message in the given locale.

Specified by:

localize in interface Localizable

Parameters:

locale - The name of the locale to localize in. This should follow the ISO 639-1 and ISO 3166-1 standards, respectively (e.g. en_US or enUS).

Returns:

The message localized as requested if possible; otherwise the message localized in the default locale if possible; otherwise the raw localization key

localizeFor

public java.lang.String localizeFor(java.lang.String playerName)
                             throws java.lang.IllegalArgumentException

Description copied from interface: Localizable

Attempts to localize this message for the player with the given username.

Specified by:

localizeFor in interface Localizable

Parameters:

playerName - The username of the player to localize this message for.

Returns:

The message localized as requested if possible; otherwise the message localized in the default locale if possible; otherwise the raw localization key

Throws:

java.lang.IllegalArgumentException - If a player with the given username cannot be found

localizeFor

public java.lang.String localizeFor(java.util.UUID playerUuid)
                             throws java.lang.IllegalArgumentException

Description copied from interface: Localizable

Attempts to localize this message for the player with the given UUID.

Specified by:

localizeFor in interface Localizable

Parameters:

playerUuid - The UUID of the player to localize this message for.

Returns:

The message localized as requested if possible; otherwise the message localized in the default locale if possible; otherwise the raw localization key

Throws:

java.lang.IllegalArgumentException - If a player with the given UUID cannot be found

localizeFor

public java.lang.String localizeFor(MGPlayer player)
                             throws java.lang.IllegalArgumentException

Description copied from interface: Localizable

Attempts to localize this message for the given MGPlayer.

Specified by:

localizeFor in interface Localizable

Parameters:

player - The MGPlayer to localize this message for

Returns:

The message localized as requested if possible; otherwise the message localized in the default locale if possible; otherwise the raw localization key

Throws:

java.lang.IllegalArgumentException - If a player with the given username cannot be found

sendTo

public void sendTo(java.lang.String playerName)
            throws java.lang.IllegalArgumentException

Description copied from interface: Localizable

Attempts to localize this message for the player with the given username and send it to them.

Specified by:

sendTo in interface Localizable

Parameters:

playerName - The username of the player to send the localized message to

Throws:

java.lang.IllegalArgumentException - If a player with the given username cannot be found

sendTo

public void sendTo(java.lang.String playerName,
                   Color color)
            throws java.lang.IllegalArgumentException

Description copied from interface: Localizable

Attempts to localize this message for the player with the given username and send it to them prefixed by the specified chat color.

Specified by:

sendTo in interface Localizable

Parameters:

playerName - The username of the player to send the localized message to

color - The color to prefix the localized string with

Throws:

java.lang.IllegalArgumentException - If a player with the given username cannot be found

sendTo

public void sendTo(java.util.UUID playerUuid)
            throws java.lang.IllegalArgumentException

Description copied from interface: Localizable

Attempts to localize this message for the player with the given username and send it to them.

Specified by:

sendTo in interface Localizable

Parameters:

playerUuid - The username of the player to send the localized message to

Throws:

java.lang.IllegalArgumentException - If a player with the given username cannot be found

sendTo

public void sendTo(java.util.UUID playerUuid,
                   Color color)
            throws java.lang.IllegalArgumentException

Description copied from interface: Localizable

Attempts to localize this message for the player with the given UUID and send it to them prefixed by the specified chat color.

Specified by:

sendTo in interface Localizable

Parameters:

playerUuid - The UUID of the player to send the localized message to

color - The color to prefix the localized string with

Throws:

java.lang.IllegalArgumentException - If a player with the given username cannot be found

broadcast

public void broadcast()

Description copied from interface: Localizable

Broadcasts this message to all players on the server in their respective locales.

Specified by:

broadcast in interface Localizable

broadcast

public void broadcast(Color color)

Description copied from interface: Localizable

Broadcasts this message, prefixed by the given color, to all players on the server in their respective locales.

Specified by:

broadcast in interface Localizable

Parameters:

color - The color to prefix the message with

broadcast

public void broadcast(java.lang.String... worlds)

Description copied from interface: Localizable

Broadcasts this message to all players in the given worlds. locales.

Specified by:

broadcast in interface Localizable

Parameters:

worlds - The names of the worlds to broadcast to

broadcast

public void broadcast(Color color,
                      java.lang.String... worlds)

Description copied from interface: Localizable

Broadcasts this message, prefixed by the given color, to all players in the given worlds. locales.

Specified by:

broadcast in interface Localizable

Parameters:

color - The color to prefix the message with

worlds - The names of the worlds to broadcast to

equals

public boolean equals(java.lang.Object otherLocalizable)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object