org.mudcraft.bukkit.socials
Class Socials

java.lang.Object
  extended by org.bukkit.plugin.java.JavaPlugin
      extended by org.mudcraft.bukkit.socials.Socials
All Implemented Interfaces:
org.bukkit.command.CommandExecutor, org.bukkit.plugin.Plugin

public class Socials
extends org.bukkit.plugin.java.JavaPlugin

The MUDCraft.org Socials plug-in.

Author:
Geoffrey Davis

Constructor Summary
Socials()
           
 
Method Summary
 java.util.List<java.lang.Class<?>> getDatabaseClasses()
          
 SocialUser loadOrCreateSocialUser(org.bukkit.entity.Player player)
          Searches for a SocialUser by player.
 SocialUser loadOrCreateSocialUser(java.lang.String playerName)
          Searches for a SocialUser by name.
 Social loadSocial(java.lang.String socialName)
          Searches for a Social by name.
 Social[] loadSocials()
          Gets the defined Socials.
 SocialUser loadSocialUser(org.bukkit.entity.Player player)
          Searches for a SocialUser by player.
 SocialUser loadSocialUser(java.lang.String playerName)
          Searches for a SocialUser by name.
 SocialUser[] loadSocialUsers()
          Gets the defined SocialUsers.
static java.util.logging.Logger logger()
          Gets a suitable logger for this class.
 Message newMessage()
          Creates a new Message.
 Message newMessage(java.lang.String formatSpecifier)
          Creates a new Message.
 void onDisable()
          
 void onEnable()
          
 void saveSocial(Social social)
          Saves a Social.
 void saveSocialUser(SocialUser user)
          Saves a SocialUser.
 
Methods inherited from class org.bukkit.plugin.java.JavaPlugin
getCommand, getConfiguration, getDatabase, getDataFolder, getDescription, getPluginLoader, getServer, isEnabled, isInitialized, isNaggable, onCommand, onLoad, setNaggable
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Socials

public Socials()
Method Detail

logger

public static java.util.logging.Logger logger()
Gets a suitable logger for this class.

Returns:
a Logger object

getDatabaseClasses

public java.util.List<java.lang.Class<?>> getDatabaseClasses()

Overrides:
getDatabaseClasses in class org.bukkit.plugin.java.JavaPlugin

loadOrCreateSocialUser

public SocialUser loadOrCreateSocialUser(org.bukkit.entity.Player player)
Searches for a SocialUser by player. If the specified Player does not have a corresponding SocialUser, one is created.

Parameters:
player - the Player for which the SocialUser is to be gotten
Returns:
the desired SocialUser
See Also:
loadOrCreateSocialUser(String)

loadOrCreateSocialUser

public SocialUser loadOrCreateSocialUser(java.lang.String playerName)
Searches for a SocialUser by name. If the Player indicated by the specified name does not have a corresponding SocialUser, one is created.

Parameters:
playerName - the name of the Player for which the SocialUser to be gotten
Returns:
the desired SocialUser or null
See Also:
loadOrCreateSocialUser(Player)

loadSocial

public Social loadSocial(java.lang.String socialName)
Searches for a Social by name.

Parameters:
socialName - the name of the Social to be gotten
Returns:
the desired Social or null
See Also:
loadSocials()

loadSocials

public Social[] loadSocials()
Gets the defined Socials.

Returns:
an array containing the defined Socials
See Also:
loadSocial(String)

loadSocialUser

public SocialUser loadSocialUser(org.bukkit.entity.Player player)
Searches for a SocialUser by player.

Parameters:
player - the Player for which the SocialUser is to be gotten
Returns:
the desired SocialUser or null
See Also:
loadSocialUser(String), loadSocialUsers()

loadSocialUser

public SocialUser loadSocialUser(java.lang.String playerName)
Searches for a SocialUser by name.

Parameters:
playerName - the name of the Player for which the SocialUser to be gotten
Returns:
the desired SocialUser or null
See Also:
loadSocialUser(Player), loadSocialUsers()

loadSocialUsers

public SocialUser[] loadSocialUsers()
Gets the defined SocialUsers.

Returns:
an array containing the defined SocialUsers
See Also:
loadSocialUser(Player), loadSocialUser(String)

newMessage

public Message newMessage()
Creates a new Message.

Returns:
a Message object
See Also:
newMessage(String)

newMessage

public Message newMessage(java.lang.String formatSpecifier)
Creates a new Message.

Parameters:
formatSpecifier - the new message's format specifier
Returns:
a Message object
See Also:
newMessage()

onDisable

public void onDisable()


onEnable

public void onEnable()


saveSocial

public void saveSocial(Social social)
Saves a Social.

Parameters:
social - the Social to be saved
See Also:
loadSocial(String), loadSocials()

saveSocialUser

public void saveSocialUser(SocialUser user)
Saves a SocialUser.

Parameters:
user - the SocialUser to be saved
See Also:
loadSocialUser(Player), loadSocialUser(String), loadSocialUsers()