net.glowstone.util

Class GlowHelpMap

java.lang.Object

net.glowstone.util.GlowHelpMap

All Implemented Interfaces:

org.bukkit.help.HelpMap

public final class GlowHelpMap
extends Object
implements org.bukkit.help.HelpMap

An implementation of HelpMap.

See http://wiki.bukkit.org/Help.yml

Constructor Summary

Constructors

Constructor and Description
GlowHelpMap(GlowServer server) Creates the instance for the given server.

Method Summary

Modifier and Type	Method and Description
void	addTopic(org.bukkit.help.HelpTopic topic)
void	amendTopics(org.bukkit.configuration.ConfigurationSection config) Process topic amendments from help.yml.
void	clear()
org.bukkit.help.HelpTopic	getHelpTopic(String topicName)
Collection<org.bukkit.help.HelpTopic>	getHelpTopics()
List<String>	getIgnoredPlugins()
void	initializeCommands() Processes all the commands registered in the server and creates help topics for them.
void	loadConfig(org.bukkit.configuration.ConfigurationSection config) Reads the general topics from help.yml and adds them to the help index.
void	registerHelpTopicFactory(Class commandClass, org.bukkit.help.HelpTopicFactory factory)

Methods inherited from class java.lang.Object

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

Constructor Detail

GlowHelpMap

public GlowHelpMap(GlowServer server)

Creates the instance for the given server.

Parameters:

server - the server

Method Detail

getHelpTopic

public org.bukkit.help.HelpTopic getHelpTopic(String topicName)

Specified by:

getHelpTopic in interface org.bukkit.help.HelpMap

getHelpTopics

public Collection<org.bukkit.help.HelpTopic> getHelpTopics()

Specified by:

getHelpTopics in interface org.bukkit.help.HelpMap

addTopic

public void addTopic(org.bukkit.help.HelpTopic topic)

Specified by:

addTopic in interface org.bukkit.help.HelpMap

clear

public void clear()

Specified by:

clear in interface org.bukkit.help.HelpMap

registerHelpTopicFactory

public void registerHelpTopicFactory(Class commandClass,
                                     org.bukkit.help.HelpTopicFactory factory)

Specified by:

registerHelpTopicFactory in interface org.bukkit.help.HelpMap

getIgnoredPlugins

public List<String> getIgnoredPlugins()

Specified by:

getIgnoredPlugins in interface org.bukkit.help.HelpMap

loadConfig

public void loadConfig(org.bukkit.configuration.ConfigurationSection config)

Reads the general topics from help.yml and adds them to the help index.

Parameters:

config - The configuration to read from.

initializeCommands

public void initializeCommands()

Processes all the commands registered in the server and creates help topics for them.

amendTopics

public void amendTopics(org.bukkit.configuration.ConfigurationSection config)

Process topic amendments from help.yml.

Parameters:

config - The configuration to read from.