com.huguesjohnson.tiamat
Class NamedObject

java.lang.Object
  com.huguesjohnson.tiamat.NamedObject

All Implemented Interfaces:

Storable

Direct Known Subclasses:

Attribute, Item, Skill

public abstract class NamedObject
extends java.lang.Object
implements Storable

NamedObject - an abstract class with a name and description

Author:

Hugues Johnson

Constructor Summary

NamedObject(java.lang.String name, java.lang.String description)

Method Summary

java.lang.String	getDescription() Returns the description of the object.
java.lang.String	getName() Returns the name of the object.
void	onDeserialize(Formatter formatter, java.lang.String absoluteDir) The onDeserialize event should be fired after an object is de-serialized.
void	setDescription(java.lang.String description) Sets the description of the object.
void	setName(java.lang.String name) Sets the name of the object.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedObject

public NamedObject(java.lang.String name,
                   java.lang.String description)

Method Detail

getName

public java.lang.String getName()

Returns the name of the object.

Returns:

The name of the object.

setName

public void setName(java.lang.String name)

Sets the name of the object.

Parameters:

name - The new name for the object.

getDescription

public java.lang.String getDescription()

Returns the description of the object.

Returns:

The description of the object.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the object.

Parameters:

description - The new description of the object.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the object.

onDeserialize

public void onDeserialize(Formatter formatter,
                          java.lang.String absoluteDir)

The onDeserialize event should be fired after an object is de-serialized. This allows objects to load transient members, set their working directory, and load Storable members if needed.

Specified by:

onDeserialize in interface Storable

Parameters:

formatter - the formatter to use to load any storable members

absoluteDir - the working directory since all paths stored in the object should be relative