be.maximvdw.placeholderapi.internal

Class PlaceholderPack

java.lang.Object

be.maximvdw.placeholderapi.internal.PlaceholderPack

Direct Known Subclasses:

CustomPlaceholdersPack

public abstract class PlaceholderPack
extends java.lang.Object

PlaceholderPack

A placeholder pack contains multiple placeholders that are grouped together

Field Summary

Fields

Modifier and Type	Field and Description
protected Plugin	plugin Plugin instance

Constructor Summary

Constructors

Constructor and Description
PlaceholderPack()
PlaceholderPack(Plugin plugin, int version)

Method Summary

Modifier and Type	Method and Description
PlaceholderPack	addOfflinePlaceholder(java.lang.String placeholder, java.lang.String description, boolean requiresplayer, PlaceholderReplacer<?> replacer) Add a new offline placeholder
PlaceholderPack	addPlaceholder(java.lang.String placeholder, java.lang.String description, OnlinePlaceholderReplacer<?> replacer) Set placeholder
PlaceholderPack	addPlaceholder(java.lang.String placeholder, java.lang.String description, PlaceholderReplacer<?> replacer) Set placeholder
void	generateConfig()
java.lang.String	getActionName()
java.lang.String	getAuthor()
YamlConfiguration	getConfig() Get config
YamlBuilder	getConfigBuilder()
int	getConfigVersion() Get config version
java.lang.String	getDescription()
java.lang.String	getId()
java.io.File	getJarFile()
java.lang.String	getName()
java.util.Set<java.lang.String>	getOfflinePlaceholder() Get placeholder
java.util.Set<java.lang.String>	getOnlinePlaceholder() Get placeholder
java.util.Set<java.lang.String>	getPlaceholder() Get placeholder
java.util.List<ModuleConstraint>	getPlaceholderConditions()
java.util.Map<java.lang.String,java.lang.String>	getPlaceholderDescriptions()
PlaceholderReplacer<?>	getPlaceholderReplacer(java.lang.String placeholder) Get placeholder replacer by placeholder
Plugin	getPlugin() Get plugin
java.lang.String	getPluginURL()
YamlStorage	getStorage() Get config storage
java.lang.String	getVersion()
boolean	hasWildcards()
boolean	isActionPlaceholder()
boolean	isEnabled()
boolean	isModule()
boolean	isOffline(java.lang.String placeholder)
abstract void	onDelete() Triggers on delete
abstract void	onDisable() Triggers on disable
abstract void	onEnable() Triggers on enable
void	removePlaceholder(java.lang.String placeholder) Remove a placeholder replacer
void	setActionName(java.lang.String actionName)
void	setActionPlaceholder(boolean actionPlaceholder)
void	setAuthor(java.lang.String author)
void	setConfigBuilder(YamlBuilder configBuilder)
void	setConfigVersion(int configVersion) Set config version
void	setContainsWildcards(boolean containsWildcards)
void	setEnabled(boolean enabled)
void	setId(java.lang.String id)
void	setJarFile(java.io.File jarFile)
void	setModule(boolean module)
void	setName(java.lang.String name) Set placeholder name
void	setStorage(YamlStorage storage) Set config storage
void	setVersion(java.lang.String version)

Methods inherited from class java.lang.Object

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

Field Detail

plugin

protected Plugin plugin

Plugin instance

Constructor Detail

PlaceholderPack

public PlaceholderPack(Plugin plugin,
                       int version)

PlaceholderPack

public PlaceholderPack()

Method Detail

onDisable

public abstract void onDisable()

Triggers on disable

onDelete

public abstract void onDelete()

Triggers on delete

onEnable

public abstract void onEnable()

Triggers on enable

getConfig

public YamlConfiguration getConfig()

Get config

Returns:

Config

getStorage

public YamlStorage getStorage()

Get config storage

Returns:

config storage

setStorage

public void setStorage(YamlStorage storage)

Set config storage

Parameters:

storage - config storage

getPlugin

public Plugin getPlugin()

Get plugin

Returns:

Plugin

getPlaceholderReplacer

public PlaceholderReplacer<?> getPlaceholderReplacer(java.lang.String placeholder)

Get placeholder replacer by placeholder

Parameters:

placeholder - Placeholder string without {}

Returns:

Placeholder replacer

getOfflinePlaceholder

public java.util.Set<java.lang.String> getOfflinePlaceholder()

Get placeholder

Returns:

placeholder

getOnlinePlaceholder

public java.util.Set<java.lang.String> getOnlinePlaceholder()

Get placeholder

Returns:

placeholder

getPlaceholder

public java.util.Set<java.lang.String> getPlaceholder()

Get placeholder

Returns:

placeholder

getPlaceholderDescriptions

public java.util.Map<java.lang.String,java.lang.String> getPlaceholderDescriptions()

addPlaceholder

public PlaceholderPack addPlaceholder(java.lang.String placeholder,
                                      java.lang.String description,
                                      OnlinePlaceholderReplacer<?> replacer)

Set placeholder

Parameters:

placeholder - Place holder

description - Description

addPlaceholder

public PlaceholderPack addPlaceholder(java.lang.String placeholder,
                                      java.lang.String description,
                                      PlaceholderReplacer<?> replacer)

Set placeholder

Parameters:

placeholder - Place holder

description - Description

addOfflinePlaceholder

public PlaceholderPack addOfflinePlaceholder(java.lang.String placeholder,
                                             java.lang.String description,
                                             boolean requiresplayer,
                                             PlaceholderReplacer<?> replacer)

Add a new offline placeholder

Parameters:

placeholder - Place holder

description - Description

generateConfig

public void generateConfig()

isOffline

public boolean isOffline(java.lang.String placeholder)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

Set placeholder name

Parameters:

name - Name

removePlaceholder

public void removePlaceholder(java.lang.String placeholder)

Remove a placeholder replacer

Parameters:

placeholder - PlaceholderPack

getPlaceholderConditions

public java.util.List<ModuleConstraint> getPlaceholderConditions()

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isActionPlaceholder

public boolean isActionPlaceholder()

setActionPlaceholder

public void setActionPlaceholder(boolean actionPlaceholder)

hasWildcards

public boolean hasWildcards()

setContainsWildcards

public void setContainsWildcards(boolean containsWildcards)

getDescription

public java.lang.String getDescription()

getPluginURL

public java.lang.String getPluginURL()

getConfigBuilder

public YamlBuilder getConfigBuilder()

setConfigBuilder

public void setConfigBuilder(YamlBuilder configBuilder)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getJarFile

public java.io.File getJarFile()

setJarFile

public void setJarFile(java.io.File jarFile)

isModule

public boolean isModule()

setModule

public void setModule(boolean module)

getAuthor

public java.lang.String getAuthor()

setAuthor

public void setAuthor(java.lang.String author)

getActionName

public java.lang.String getActionName()

setActionName

public void setActionName(java.lang.String actionName)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getConfigVersion

public int getConfigVersion()

Get config version

Returns:

config version

setConfigVersion

public void setConfigVersion(int configVersion)

Set config version

Parameters:

configVersion - config version