Package fr.prodrivers.bukkit.commons.sections

Class SectionManager

java.lang.Object

fr.prodrivers.bukkit.commons.sections.SectionManager

public class SectionManager
extends Object

Prodrivers Commons Section Manager

Constructor Summary

Constructors

Constructor	Description
SectionManager()

Method Summary

Modifier and Type	Method	Description
static void	enter(org.bukkit.entity.Player player)	Make a player enter his current section's preferred next section
static void	enter(org.bukkit.entity.Player player, String sectionName)	Make a player enter a section by section name.
static void	enter(org.bukkit.entity.Player player, String sectionName, String subSection)	Make a player enter a section by section name.
static void	enter(org.bukkit.entity.Player player, String sectionName, String subSection, boolean force)	Make a player enter a section by section name.
static IProdriversSection	getCurrentSection(org.bukkit.entity.Player player)	Get a player's current section instance
static void	register(IProdriversSection section)	Register a new section instance against the Prodrivers Commons infrastructure

Methods inherited from class java.lang.Object

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

Constructor Details

SectionManager

public SectionManager()

Method Details

enter

public static void enter(org.bukkit.entity.Player player)
                  throws NoCurrentSectionException,
NoNextSectionException,
IllegalSectionLeavingException,
IllegalSectionEnteringException

Make a player enter his current section's preferred next section

Parameters:

player - Player to be moved

Throws:

NoCurrentSectionException - The player does not have a current section

NoNextSectionException - The player's current section does not have a next section

IllegalSectionLeavingException - The current section forbids the player to go to the preferred next section

IllegalSectionEnteringException - The player should not enter the preferred next section

enter

public static void enter(org.bukkit.entity.Player player,
 String sectionName)
                  throws InvalidSectionException,
IllegalSectionLeavingException,
IllegalSectionEnteringException,
NotPartyOwnerException

Make a player enter a section by section name. If the current section force a specific target section, this method will fail gracefully.

Parameters:

player - Player to be moved

sectionName - Section name to go to

Throws:

InvalidSectionException - Invalid section name provided

IllegalSectionLeavingException - The current section forbids the player to go to the desired section

IllegalSectionEnteringException - The player should not enter the desired section

NotPartyOwnerException - The player is in a party and is trying to enter a section not authorized as a non-party owner

enter

public static void enter(org.bukkit.entity.Player player,
 String sectionName,
 String subSection)
                  throws InvalidSectionException,
IllegalSectionLeavingException,
IllegalSectionEnteringException,
NotPartyOwnerException

Make a player enter a section by section name. If the current section force a specific target section, this method will fail gracefully.

Parameters:

player - Player to be moved

sectionName - Section name to go to

subSection - Sub-section to go to

Throws:

InvalidSectionException - Invalid section name provided

IllegalSectionLeavingException - The current section forbids the player to go to the desired section

IllegalSectionEnteringException - The player should not enter the desired section

NotPartyOwnerException - The player is in a party and is trying to enter a section not authorized as a non-party owner

enter

public static void enter(org.bukkit.entity.Player player,
 String sectionName,
 String subSection,
 boolean force)
                  throws InvalidSectionException,
IllegalSectionLeavingException,
IllegalSectionEnteringException,
NotPartyOwnerException

Make a player enter a section by section name.

Parameters:

player - Player to be moved

sectionName - Section name to go to

subSection - Sub-section to go to

force - Force the player to go to the target section, even if his current section prefers another. He will be successively transferred to intermediate preferred sections to avoid any problems.

Throws:

InvalidSectionException - Invalid section name provided

IllegalSectionLeavingException - The current section forbids the player to go to the desired section

IllegalSectionEnteringException - The player should not enter the desired section

NotPartyOwnerException - The player is in a party and is trying to enter a section not authorized as a non-party owner

register

public static void register(IProdriversSection section)
                     throws NullPointerException

Register a new section instance against the Prodrivers Commons infrastructure

Parameters:

section - Prodrivers Commons-compatible section to register

Throws:

NullPointerException - Provided section is null

getCurrentSection

public static IProdriversSection getCurrentSection(org.bukkit.entity.Player player)

Get a player's current section instance

Parameters:

player - Player to consider

Returns:

Player's section instance if possible or null