com.comphenix.xp.parser.text

Class MobMatcher

java.lang.Object

com.comphenix.xp.parser.TextParser<java.util.List<java.lang.Short>>

com.comphenix.xp.parser.text.MobMatcher

public class MobMatcher
extends TextParser<java.util.List<java.lang.Short>>

Used by the MobEntityTypeParser to parse mob names or categories.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
MobMatcher()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.Short>	getCategoryFromName(java.lang.String text) Retrieves the category with the same ENUM name, or NULL if no such category exists.
java.lang.Short	getMobFromName(java.lang.String text) Retrieves the mob with the same ENUM name, or NULL if no such mob is registered.
java.util.Collection<java.lang.String>	getRegisteredCategories() Retrieves a collection of currently registered categories.
java.util.Collection<java.lang.String>	getRegisteredMobs() Retrieves a collection of currently registered mobs.
protected void	loadDefaultCategories()
protected void	loadDefaultMobs()
java.util.List<java.lang.Short>	parse(java.lang.String text) Transforms the given text into an object.
void	registerCategory(java.lang.String categoryName, org.bukkit.entity.EntityType... types) Registers a category with the given name.
void	registerCategory(java.lang.String categoryName, java.lang.Short... types) Registers a category with the given name.
void	registerMob(java.lang.String mobName, java.lang.Short id) Register an individual mob.
java.util.List<java.lang.Short>	unregisterCategory(java.lang.String categoryName) Unregisters the given category.
java.lang.Short	unregisterMob(java.lang.String mobName) Unregisters an individual mob.

Methods inherited from class com.comphenix.xp.parser.TextParser

getParameterQueue, parse, tryParse, tryParse

Methods inherited from class java.lang.Object

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

Constructor Detail

MobMatcher

public MobMatcher()

Method Detail

loadDefaultCategories

protected void loadDefaultCategories()

loadDefaultMobs

protected void loadDefaultMobs()

getCategoryFromName

public java.util.List<java.lang.Short> getCategoryFromName(java.lang.String text)

Retrieves the category with the same ENUM name, or NULL if no such category exists.

Parameters:

text - - name of the category to find.

Returns:

The found category's list of mobs, or NULL if no such category can be found.

getMobFromName

public java.lang.Short getMobFromName(java.lang.String text)

Retrieves the mob with the same ENUM name, or NULL if no such mob is registered.

Parameters:

text - - name of the mob to find.

Returns:

The found mob ID, or NULL if no such mob can be found.

registerCategory

public void registerCategory(java.lang.String categoryName,
                    org.bukkit.entity.EntityType... types)

Registers a category with the given name.

Parameters:

categoryName - - name of the category.

types - - list of mobs in that category.

registerCategory

public void registerCategory(java.lang.String categoryName,
                    java.lang.Short... types)

Registers a category with the given name.

Parameters:

categoryName - - name of the category.

types - - list of mob ids in that category.

unregisterCategory

public java.util.List<java.lang.Short> unregisterCategory(java.lang.String categoryName)

Unregisters the given category.

Parameters:

categoryName - - name of the category to unregister.

Returns:

List of mobs from the category that was unregistered, or NULL if no category could be found.

getRegisteredCategories

public java.util.Collection<java.lang.String> getRegisteredCategories()

Retrieves a collection of currently registered categories.

Returns:

Collection of registered categories.

registerMob

public void registerMob(java.lang.String mobName,
               java.lang.Short id)

Register an individual mob.

Parameters:

mobName - - ENUM name of the mob.

id - - the unique type ID of the mob.

unregisterMob

public java.lang.Short unregisterMob(java.lang.String mobName)

Unregisters an individual mob.

Parameters:

mobName - - name of the mob to unregister.

Returns:

The previously registered mob's ID, or NULl if no mob could be found.

getRegisteredMobs

public java.util.Collection<java.lang.String> getRegisteredMobs()

Retrieves a collection of currently registered mobs.

Returns:

Collection of registered mobs.

parse

public java.util.List<java.lang.Short> parse(java.lang.String text)
                                      throws ParsingException

Description copied from class: TextParser

Transforms the given text into an object.

Specified by:

parse in class TextParser<java.util.List<java.lang.Short>>

Parameters:

text - - text to parse.

Returns:

Result of the parsing.

Throws:

ParsingException - The text cannot be transformed into a list of objects.