com.comphenix.xp.parser.text

Class ItemNameParser

java.lang.Object

com.comphenix.xp.parser.TextParser<java.util.Set<java.lang.Integer>>

com.comphenix.xp.parser.text.ItemNameParser

public class ItemNameParser
extends TextParser<java.util.Set<java.lang.Integer>>

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.collect.SetMultimap<java.lang.String,java.lang.Integer>	lookupMaterial

Constructor Summary

Constructors

Constructor and Description
ItemNameParser()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Integer	getFirstRegistered(java.lang.String name) Retrieves the first registered item, or NULL if not found.
java.util.Collection<java.lang.Integer>	getRegistered(java.lang.String name) Retrieves the set of registered IDs directly.
protected void	loadDefaultList()
java.util.Set<java.lang.Integer>	parse(java.lang.String text) Determines the item, either by ID or name, of the given string of characters.
void	register(java.lang.String name, java.lang.Integer id) Registers a new material for the item parser.
void	register(java.lang.String name, org.bukkit.Material material) Registers a new material for the item parser.
void	unregister(java.lang.String name, java.lang.Integer id) Dissociates the given name by the given ID.

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

Field Detail

lookupMaterial

protected com.google.common.collect.SetMultimap<java.lang.String,java.lang.Integer> lookupMaterial

Constructor Detail

ItemNameParser

public ItemNameParser()

Method Detail

loadDefaultList

protected void loadDefaultList()

register

public void register(java.lang.String name,
            org.bukkit.Material material)

Registers a new material for the item parser.

Parameters:

name - - name of the material. Only capital letters and no underscores/spaces.

material - - the associated material.

register

public void register(java.lang.String name,
            java.lang.Integer id)

Registers a new material for the item parser.

Parameters:

name - - name of the material. Only capital letters and no underscores/spaces.

id - - the associated material id.

getRegistered

public java.util.Collection<java.lang.Integer> getRegistered(java.lang.String name)

Retrieves the set of registered IDs directly.

Parameters:

name - - material to find.

Returns:

Collection of registered IDs by this name.

getFirstRegistered

public java.lang.Integer getFirstRegistered(java.lang.String name)

Retrieves the first registered item, or NULL if not found.

Parameters:

name - - the name of the item to search for.

Returns:

ID of the first registered item, or NULL if not found.

unregister

public void unregister(java.lang.String name,
              java.lang.Integer id)

Dissociates the given name by the given ID.

Parameters:

name - - name to find.

id - - ID to remove.

parse

public java.util.Set<java.lang.Integer> parse(java.lang.String text)
                                       throws ParsingException

Determines the item, either by ID or name, of the given string of characters.

Specified by:

parse in class TextParser<java.util.Set<java.lang.Integer>>

Parameters:

text - String of characters.

Returns:

ID of the item parsed.

Throws:

ParsingException - Invoked when an unrecognized item name is given.