Package me.remigio07.chatplugin.api.server.tablist

Class Tablist

java.lang.Object

me.remigio07.chatplugin.api.server.tablist.Tablist

public class Tablist
extends Object

Represents a tablist handled by the TablistManager.

See Also:

• ChatPlugin wiki/Modules/Tablists

Field Summary

Fields

Modifier and Type	Field	Description
static final Tablist	NULL_TABLIST	Tablist used to reset a player's header and footer.

Constructor Summary

Constructors

Constructor	Description
Tablist(String id, Map<Language,String> headers, Map<Language,String> footers)	Constructs a new tablist.

Method Summary

Modifier and Type	Method	Description
String	getFooter(Language language, boolean avoidNull)	Gets this tablist's footer for the specified language.
Map<Language,String>	getFooters()	Gets this tablist's footers.
String	getHeader(Language language, boolean avoidNull)	Gets this tablist's header for the specified language.
Map<Language,String>	getHeaders()	Gets this tablist's headers.
String	getID()	Gets this tablist's ID.

Methods inherited from class java.lang.Object

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

Field Details

NULL_TABLIST

public static final Tablist NULL_TABLIST

Tablist used to reset a player's header and footer.

Some of its instance methods will return null. TablistSendEvent is not called when sending this tablist.

Constructor Details

Tablist

public Tablist(String id,
 Map<Language,String> headers,
 Map<Language,String> footers)

Constructs a new tablist.

You have two ways to send it to a player:

• using TablistManager.sendTablist(Tablist, ChatPluginServerPlayer)
• by adding it to TablistManager.getTablists(); in this case it will be removed on ChatPluginManager.unload()

Parameters:

id - Tablist's ID

headers - Tablist's headers

footers - Tablist's footers

Throws:

IllegalArgumentException - If specified ID !TablistManager.isValidTablistID(String) || headers.get(Language.getMainLanguage()) == null || footers.get(Language.getMainLanguage()) == null

Method Details

getID

public String getID()

Gets this tablist's ID.

Returns:

Tablist's ID

getHeaders

public Map<Language,String> getHeaders()

Gets this tablist's headers.

You may modify the returned map, but it cannot point to a null value for Language.getMainLanguage().

Returns:

Tablist's headers

getHeader

public String getHeader(Language language,
 boolean avoidNull)

Gets this tablist's header for the specified language.

Specify true as avoidNull to fall back to Language.getMainLanguage()'s header if no header is present for the specified language. Will return null if getHeaders().get(language) == null && !avoidNull.

Parameters:

language - Language used to translate the text

avoidNull - Whether to avoid returning null

Returns:

Tablist's header

getFooters

public Map<Language,String> getFooters()

Gets this tablist's footers.

You may modify the returned map, but it cannot point to a null value for Language.getMainLanguage().

Returns:

Tablist's footers

getFooter

public String getFooter(Language language,
 boolean avoidNull)

Gets this tablist's footer for the specified language.

Specify true as avoidNull to fall back to Language.getMainLanguage()'s footer if no footer is present for the specified language. Will return null if getFooters().get(language) == null && !avoidNull.

Parameters:

language - Language used to translate the text

avoidNull - Whether to avoid returning null

Returns:

Tablist's footer