com.jagrosh.jdautilities.command

Interface GuildSettingsProvider

public interface GuildSettingsProvider

A basic frame that is optionally implementable by objects returned from GuildSettingsManager#getSettings(Guild).

This interface allows the specification of any of the following functions:

• Guild Specific Prefixes (via getPrefixes())

Note that all of these functions are OPTIONAL to implement, and instructions are available in method documentation on how to implement properly.
Additionally, as stated before, the interface itself does not need to be implemented for an object to be returned handled by a GuildSettingsManager.

Since:

2.0

Author:

Kaidan Gustave

Implementation Note:

Unless in the event of a major breaking change to JDA, there is no chance of implementations of this interface being required to implement additional methods.
If in the future it is decided to add a method to this interface, the method will have a default implementation that doesn't require developer additions.

Method Summary

Modifier and Type	Method and Description
default java.util.Collection<java.lang.String>	getPrefixes() Gets a Collection of String prefixes available for the Guild represented by this implementation.

Method Detail

getPrefixes

@Nullable
default java.util.Collection<java.lang.String> getPrefixes()

Gets a Collection of String prefixes available for the Guild represented by this implementation.

An empty Collection or null may be returned to signify the Guild doesn't have any guild specific prefixes, or that this feature is not supported by this implementation.

Returns:

A Collection of String prefixes for the Guild represented by this implementation, or null to signify it has none or that the feature is not supported by the implementation.