com.planet_ink.coffee_mud.Libraries.interfaces
Class WorldMap.MapCacheEntry

java.lang.Object
  com.planet_ink.coffee_mud.Libraries.interfaces.WorldMap.MapCacheEntry

All Implemented Interfaces:

CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>

Enclosing interface:

WorldMap

public static class WorldMap.MapCacheEntry
extends java.lang.Object
implements CMObject

Field Summary

java.lang.String	ID
long	lastAccessed
java.util.List<Room>	rooms

Constructor Summary

WorldMap.MapCacheEntry(java.lang.String ID, java.util.List<Room> rooms)

Method Summary

int	compareTo(CMObject o)
CMObject	copyOf() Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
void	initializeClass() Called ONCE after all objects are loaded, but before the map is read in during initialization.
CMObject	newInstance() Returns a new instance of this class.

Methods inherited from class java.lang.Object

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

Field Detail

rooms

public final java.util.List<Room> rooms

ID

public final java.lang.String ID

lastAccessed

public volatile long lastAccessed

Constructor Detail

WorldMap.MapCacheEntry

public WorldMap.MapCacheEntry(java.lang.String ID,
                              java.util.List<Room> rooms)

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Returns:

the name of this class

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Returns:

a clone of this object

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Returns:

a new instance of this class

compareTo

public int compareTo(CMObject o)

Specified by:

compareTo in interface java.lang.Comparable<CMObject>