vooga.engine.resource.modules
Class StringModule

java.lang.Object
  vooga.engine.resource.modules.ResourceModule
      vooga.engine.resource.modules.StringModule

public class StringModule
extends ResourceModule

ResourceModule designed to track Strings which act as constants throughout the game.

Constructor Summary

StringModule()

Method Summary

void	clearElements() Clears the current resource map.
static java.lang.String	getString(java.lang.String key) Returns the String associated with the given String label.
void	loadElements(java.util.Collection<org.w3c.dom.Element> elements) Adds Elements to the resource map.
static void	loadString(java.lang.String key, java.lang.String stringToLoad) Puts a new entry into this Resources's stringMap, with a String key and a String value.

Methods inherited from class vooga.engine.resource.modules.ResourceModule

getDefaultPath, getGame, setDefaultPath, setGame

Methods inherited from class java.lang.Object

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

Constructor Detail

StringModule

public StringModule()

Method Detail

clearElements

public void clearElements()

Description copied from class: ResourceModule

Clears the current resource map. Resource maps should be cleared when they are full of currently unneeded resources and the game is starting to use too much memory.

Specified by:

clearElements in class ResourceModule

loadElements

public void loadElements(java.util.Collection<org.w3c.dom.Element> elements)

Description copied from class: ResourceModule

Adds Elements to the resource map. Presumably, these elements are part of a Document from parsing an XML file using the Document Object Model

Specified by:

loadElements in class ResourceModule

Parameters:

elements - Elements of the parsed XML document to be added

loadString

public static void loadString(java.lang.String key,
                              java.lang.String stringToLoad)

Puts a new entry into this Resources's stringMap, with a String key and a String value.

getString

public static java.lang.String getString(java.lang.String key)

Returns the String associated with the given String label.