Module watamebot

Package net.foxgenesis.watame.property

Interface PluginPropertyProvider

All Superinterfaces:

PropertyProvider<Plugin,String,net.dv8tion.jda.api.entities.Guild,PluginPropertyMapping>

public interface PluginPropertyProvider
extends PropertyProvider<Plugin,String,net.dv8tion.jda.api.entities.Guild,PluginPropertyMapping>

Method Summary

Modifier and Type	Method	Description
PluginProperty	getProperty(PropertyInfo info)	Get a PluginProperty linked to the specified PropertyInfo.
PluginProperty	getProperty(Plugin plugin, String key)	Get a PluginProperty based on the specified property owner and name.
PluginProperty	getPropertyByID(int id)	Get a PluginProperty based on the specified property information id.
PluginProperty	upsertProperty(Plugin plugin, String key, boolean modifiable, PropertyType type)	Register a PropertyInfo if it does not exist inside the configuration and return a new PluginProperty created with the property information.

Methods inherited from interface net.foxgenesis.property.PropertyProvider

getPropertyList, propertyExists, registerProperty

Method Details

upsertProperty

PluginProperty upsertProperty(Plugin plugin,
 String key,
 boolean modifiable,
 PropertyType type)

Register a PropertyInfo if it does not exist inside the configuration and return a new PluginProperty created with the property information.

Specified by:

upsertProperty in interface PropertyProvider<Plugin,String,net.dv8tion.jda.api.entities.Guild,PluginPropertyMapping>

Parameters:

plugin - - property owner

key - - property name

modifiable - - if can be modified by the end user

type - - property storage type

Returns:

Returns a PluginProperty with the specified PropertyInfo

getPropertyByID

PluginProperty getPropertyByID(int id)

Get a PluginProperty based on the specified property information id.

Specified by:

getPropertyByID in interface PropertyProvider<Plugin,String,net.dv8tion.jda.api.entities.Guild,PluginPropertyMapping>

Parameters:

id - - PropertyInfo id

Returns:

Returns a PluginProperty using the specified PropertyInfo id

getProperty

PluginProperty getProperty(Plugin plugin,
 String key)

Get a PluginProperty based on the specified property owner and name.

Specified by:

getProperty in interface PropertyProvider<Plugin,String,net.dv8tion.jda.api.entities.Guild,PluginPropertyMapping>

Parameters:

plugin - - property owner

key - - property name

Returns:

Returns a PluginProperty linked to the PropertyInfo category and name

getProperty

PluginProperty getProperty(PropertyInfo info)

Get a PluginProperty linked to the specified PropertyInfo.

Specified by:

getProperty in interface PropertyProvider<Plugin,String,net.dv8tion.jda.api.entities.Guild,PluginPropertyMapping>

Parameters:

info - - property information

Returns:

Returns a PluginProperty with the specified info