Package com.planet_ink.coffee_mud.Common

Class DefaultTattoo

java.lang.Object

com.planet_ink.coffee_mud.Common.DefaultTattoo

All Implemented Interfaces:

CMCommon, Tattoo, CMObject, Expireable, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DefaultTattoo
extends java.lang.Object
implements Tattoo

Field Summary

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

idConverter

Constructor Summary

Constructors

Constructor	Description
DefaultTattoo()

Method Summary

Modifier and Type	Method	Description
int	compareTo(CMObject o)
Tattoo	copyOf()	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
boolean	equals(java.lang.Object o)
long	expirationDate()	If this object expires, it should have a timestamp saying when it expires, in real time.
java.lang.String	getTattooName()	Returns the tattoo Name
int	getTickDown()	Returns the current tick-down
int	hashCode()
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.
Tattoo	parse(java.lang.String tattooCode)	Parse a new tattoo object from the coded data, of the form: TATOONAME or NUMBER TATTOONAME
Tattoo	set(java.lang.String name)	Set the tattoo name
Tattoo	set(java.lang.String name, int down)	Set the tatoo name and tick-down
void	setExpirationDate(long dateTime)	If this object expires, it should have a timestamp saying when it expires, in real time.
void	setTickDown(int tickDown)	Sets the current tick down, or resets it
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultTattoo

public DefaultTattoo()

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()

set

public Tattoo set(java.lang.String name)

Description copied from interface: Tattoo

Set the tattoo name

Specified by:

set in interface Tattoo

Parameters:

name - the tattoo name

Returns:

this

set

public Tattoo set(java.lang.String name,
                  int down)

Description copied from interface: Tattoo

Set the tatoo name and tick-down

Specified by:

set in interface Tattoo

Parameters:

name - the tatoo name

down - the tick down life span

Returns:

this

setTickDown

public final void setTickDown(int tickDown)

Description copied from interface: Tattoo

Sets the current tick down, or resets it

Specified by:

setTickDown in interface Tattoo

Parameters:

tickDown - the tickDown

getTickDown

public final int getTickDown()

Description copied from interface: Tattoo

Returns the current tick-down

Specified by:

getTickDown in interface Tattoo

Returns:

the tickDown

getTattooName

public final java.lang.String getTattooName()

Description copied from interface: Tattoo

Returns the tattoo Name

Specified by:

getTattooName in interface Tattoo

Returns:

the tattooName

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

copyOf

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

expirationDate

public long expirationDate()

Description copied from interface: Expireable

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

expirationDate in interface Expireable

Returns:

the time stamp when this thing expires

See Also:

Expireable.setExpirationDate(long)

setExpirationDate

public void setExpirationDate(long dateTime)

Description copied from interface: Expireable

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

setExpirationDate in interface Expireable

Parameters:

dateTime - the time stamp when this thing expires

See Also:

Expireable.expirationDate()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

parse

public Tattoo parse(java.lang.String tattooCode)

Description copied from interface: Tattoo

Parse a new tattoo object from the coded data, of the form: TATOONAME or NUMBER TATTOONAME

Specified by:

parse in interface Tattoo

Parameters:

tattooCode - coded data

Returns:

this tattoo

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object