me.lucko.helper.mongo.plugin

Class HelperMongoPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

me.lucko.helper.plugin.ExtendedJavaPlugin

me.lucko.helper.mongo.plugin.HelperMongoPlugin

All Implemented Interfaces:

MongoProvider, HelperPlugin, TerminableConsumer, org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class HelperMongoPlugin
extends ExtendedJavaPlugin
implements MongoProvider

Constructor Summary

Constructors

Constructor and Description
HelperMongoPlugin()

Method Summary

Modifier and Type	Method and Description
protected void	enable()
MongoDatabaseCredentials	getGlobalCredentials() Gets the global database credentials being used for the global datasource.
Mongo	getMongo() Gets the global datasource.
Mongo	getMongo(MongoDatabaseCredentials credentials) Constructs a new datasource using the given credentials.

Methods inherited from class me.lucko.helper.plugin.ExtendedJavaPlugin

bind, bindModule, disable, getBundledFile, getClassloader, getPlugin, getService, isPluginEnabled, load, loadConfig, loadConfigNode, onDisable, onEnable, onLoad, provideService, provideService, registerCommand, registerListener, setupConfig

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bukkit.plugin.Plugin

getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getLogger, getName, getPluginLoader, getResource, getServer, isEnabled, isNaggable, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setNaggable

Methods inherited from interface org.bukkit.command.TabCompleter

onTabComplete

Methods inherited from interface org.bukkit.command.CommandExecutor

onCommand

Constructor Detail

HelperMongoPlugin

public HelperMongoPlugin()

Method Detail

enable

protected void enable()

Overrides:

enable in class ExtendedJavaPlugin

getMongo

@Nonnull
public Mongo getMongo()

Description copied from interface: MongoProvider

Gets the global datasource.

Specified by:

getMongo in interface MongoProvider

Returns:

the global datasource.

getMongo

@Nonnull
public Mongo getMongo(@Nonnull
                                MongoDatabaseCredentials credentials)

Description copied from interface: MongoProvider

Constructs a new datasource using the given credentials.

These instances are not cached, and a new datasource is created each time this method is called.

Specified by:

getMongo in interface MongoProvider

Parameters:

credentials - the credentials for the database

Returns:

a new datasource

getGlobalCredentials

@Nonnull
public MongoDatabaseCredentials getGlobalCredentials()

Description copied from interface: MongoProvider

Gets the global database credentials being used for the global datasource.

Specified by:

getGlobalCredentials in interface MongoProvider

Returns:

the global credentials