Package com.planet_ink.coffee_mud.Common

Class DefaultTattooable

java.lang.Object

com.planet_ink.coffee_mud.Common.DefaultTattooable

All Implemented Interfaces:

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

public class DefaultTattooable
extends java.lang.Object
implements Tattooable, CMCommon

Field Summary

Fields

Modifier and Type	Field	Description
protected CMUniqNameSortSVec<Tattoo>	tattoos

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Constructor Summary

Constructors

Constructor	Description
DefaultTattooable()

Method Summary

Modifier and Type	Method	Description
void	addTattoo(Tattoo of)	Add a new tattoo to this object
void	addTattoo(java.lang.String of)	Manipulation of the tatoo list
void	addTattoo(java.lang.String of, int tickDown)	Add a new tattoo to this object
int	compareTo(CMObject o)
Tattooable	copyOf()	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
void	delTattoo(Tattoo of)	Remove a specific tattoo from this object
boolean	delTattoo(java.lang.String of)	Remove a specific tattoo from this object
Tattoo	findTattoo(java.lang.String of)	Returns the tattoo of the given marker name
Tattoo	findTattooStartsWith(java.lang.String of)	Returns the tattoo that starts with the given marker name
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.
java.lang.String	name()	The displayable name of this object.
CMObject	newInstance()	Returns a new instance of this class.
java.util.Enumeration<Tattoo>	tattoos()	Returns an enumeration of all the tattoos on this object.

Methods inherited from class java.lang.Object

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

Field Detail

tattoos

protected CMUniqNameSortSVec<Tattoo> tattoos

Constructor Detail

DefaultTattooable

public DefaultTattooable()

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, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Returns:

the name of this class

name

public java.lang.String name()

Description copied from interface: CMObject

The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().

Specified by:

name in interface CMObject

Returns:

the modified final name of this object on the map.

See Also:

Environmental.Name()

copyOf

public Tattooable 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

compareTo

public int compareTo(CMObject o)

Specified by:

compareTo in interface java.lang.Comparable<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

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

addTattoo

public void addTattoo(java.lang.String of)

Manipulation of the tatoo list

Specified by:

addTattoo in interface Tattooable

Parameters:

of - the permanent tattoo name to add

See Also:

Tattooable, Tattooable.addTattoo(String, int), Tattooable.addTattoo(Tattoo)

addTattoo

public void addTattoo(java.lang.String of,
                      int tickDown)

Description copied from interface: Tattooable

Add a new tattoo to this object

Specified by:

addTattoo in interface Tattooable

Parameters:

of - the permanent tattoo name to add

tickDown - the ticks of life for this tattoo

See Also:

Tattooable, Tattooable.addTattoo(String), Tattooable.addTattoo(Tattoo)

delTattoo

public boolean delTattoo(java.lang.String of)

Description copied from interface: Tattooable

Remove a specific tattoo from this object

Specified by:

delTattoo in interface Tattooable

Parameters:

of - the tattoo name of the tattoo to remove

Returns:

TODO

See Also:

Tattooable, Tattooable.delTattoo(Tattoo)

addTattoo

public void addTattoo(Tattoo of)

Description copied from interface: Tattooable

Add a new tattoo to this object

Specified by:

addTattoo in interface Tattooable

Parameters:

of - the tattoo object to add

See Also:

Tattooable, Tattooable.addTattoo(String, int), Tattooable.addTattoo(String)

delTattoo

public void delTattoo(Tattoo of)

Description copied from interface: Tattooable

Remove a specific tattoo from this object

Specified by:

delTattoo in interface Tattooable

Parameters:

of - the tattoo object to remove

See Also:

Tattooable, Tattooable.delTattoo(String)

tattoos

public java.util.Enumeration<Tattoo> tattoos()

Description copied from interface: Tattooable

Returns an enumeration of all the tattoos on this object.

Specified by:

tattoos in interface Tattooable

Returns:

an enumeration of all the tattoos on this object.

See Also:

Tattooable

findTattoo

public Tattoo findTattoo(java.lang.String of)

Description copied from interface: Tattooable

Returns the tattoo of the given marker name

Specified by:

findTattoo in interface Tattooable

Parameters:

of - the marker name to return a tattoo for

Returns:

the tattoo of the given marker name

See Also:

Tattooable, Tattooable.findTattooStartsWith(String)

findTattooStartsWith

public Tattoo findTattooStartsWith(java.lang.String of)

Description copied from interface: Tattooable

Returns the tattoo that starts with the given marker name

Specified by:

findTattooStartsWith in interface Tattooable

Parameters:

of - the marker name to return a tattoo starter for

Returns:

the tattoo that starts with the given marker name

See Also:

Tattooable, Tattooable.findTattoo(String)