Package me.remigio07.chatplugin.api.server.ad

Class Ad

java.lang.Object

me.remigio07.chatplugin.api.server.ad.Ad

public class Ad
extends Object

Represents an ad handled by the AdManager.

See Also:

• ChatPlugin wiki/Modules/Ads

Constructor Summary

Constructors

Constructor	Description
Ad(String id, Map<Language,String> texts, Map<Language,String> hovers, ClickActionAdapter clickAction, Map<Language,String> clickValues, List<Rank> disabledRanks)	Constructs a new ad.

Method Summary

Modifier and Type	Method	Description
ClickActionAdapter	getClickAction()	Gets this ad's click action.
String	getClickValue(Language language)	Gets this ad's click value for the specified language.
Map<Language,String>	getClickValues()	Gets this ad's click values.
List<Rank>	getDisabledRanks()	Gets the list of ranks that will not receive this ad.
String	getHover(Language language)	Gets this ad's hover for the specified language.
Map<Language,String>	getHovers()	Gets this ad's hovers.
String	getID()	Gets this ad's ID.
String	getText(Language language, boolean avoidNull)	Gets this ad's text for the specified language.
Map<Language,String>	getTexts()	Gets this ad's texts.
Ad	setClickAction(ClickActionAdapter clickAction)	Sets this ad's click action.

Methods inherited from class java.lang.Object

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

Constructor Details

Ad

public Ad(String id,
 Map<Language,String> texts,
 Map<Language,String> hovers,
 ClickActionAdapter clickAction,
 Map<Language,String> clickValues,
 List<Rank> disabledRanks)

Constructs a new ad.

You have two ways to send it to a player:

• using AdManager.sendAd(Ad, ChatPluginServerPlayer)
• by adding it to AdManager.getAds(); in this case it will be removed on ChatPluginManager.unload()

Parameters:

id - Ad's ID

texts - Ad's texts

hovers - Ad's hovers

clickAction - Ad's click action

clickValues - Ad's click values

disabledRanks - Ranks that will not receive the ad

Throws:

IllegalArgumentException - If specified ID !AdManager.isValidAdID(String)

NoSuchElementException - If texts.get(Language.getMainLanguage()) == null (other two maps may contain null values)

Method Details

getID

public String getID()

Gets this ad's ID.

Returns:

Ad's ID

getTexts

public Map<Language,String> getTexts()

Gets this ad's texts.

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

Returns:

Ad's texts

getText

public String getText(Language language,
 boolean avoidNull)

Gets this ad's text for the specified language.

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

Parameters:

language - Language used to translate the text

avoidNull - Whether to avoid returning null

Returns:

Ad's text

getHovers

public Map<Language,String> getHovers()

Gets this ad's hovers.

You may modify the returned map.

Returns:

Ad's hovers

getHover

public String getHover(Language language)

Gets this ad's hover for the specified language.

Will return null if getHovers().get(language) == null.

Parameters:

language - Language used to translate the hover

Returns:

Ad's hover

getClickAction

public ClickActionAdapter getClickAction()

Gets this ad's click action.

Will return null if the click action has not been specified.

Returns:

Ad's click action

setClickAction

public Ad setClickAction(ClickActionAdapter clickAction)

Sets this ad's click action.

Specify null to not specify a click action.

Parameters:

clickAction - Ad's click action

Returns:

This ad

getClickValues

public Map<Language,String> getClickValues()

Gets this ad's click values.

You may modify the returned map.

Returns:

Ad's click values

getClickValue

public String getClickValue(Language language)

Gets this ad's click value for the specified language.

Will return null if getClickValues().get(language) == null.

Parameters:

language - Language used to translate the click value

Returns:

Ad's click value

getDisabledRanks

public List<Rank> getDisabledRanks()

Gets the list of ranks that will not receive this ad.

You may modify the returned list.

Returns:

Ad's disabled ranks