Package anecho.JamochaMUD.plugins.PathWalkerDir

Class Path

java.lang.Object

anecho.JamochaMUD.plugins.PathWalkerDir.Path

public class Path
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Path()	Constructor using a default path name "DefaultPath"
Path(java.lang.String pName)	Constructor assigning a path name.
Path(org.w3c.dom.Node n)	Constructor from an XML node.

Method Summary

Modifier and Type	Method	Description
void	addNode(org.w3c.dom.Document d, org.w3c.dom.Node root)	Write out the path as an XML node in a supplied document.
void	addStep(java.lang.String dir)	Add a step to the current path macro.
Path	getCopy()	Get a copy of this object
int	getCount()	Get the number of movement commands in the path
java.lang.String	getName()	get the name of the path
java.lang.String[]	getSteps()	Return the path steps as an array.
java.lang.String[]	getStepsReverse()	Return the paths reverse-direction steps.
int	hashCode()
void	setName(java.lang.String newName)	Set the "name" of the path.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Path

public Path()

Constructor using a default path name "DefaultPath"

Path

public Path(java.lang.String pName)
     throws InvalidPathException

Constructor assigning a path name. Null path name not allowed

Throws:

InvalidPathException

Path

public Path(org.w3c.dom.Node n)

Constructor from an XML node. Used for loading the paths from the saved configuration file.

Method Detail

addNode

public void addNode(org.w3c.dom.Document d,
                    org.w3c.dom.Node root)

Write out the path as an XML node in a supplied document. Used for generating the XML configuration file.

setName

public void setName(java.lang.String newName)
             throws InvalidPathException

Set the "name" of the path. A null name will throw InvalidPathException.

Throws:

InvalidPathException

getName

public java.lang.String getName()

get the name of the path

getCount

public int getCount()

Get the number of movement commands in the path

addStep

public void addStep(java.lang.String dir)

Add a step to the current path macro. Ignore the input if we don't recognize a valid direction. The direction must as follows: short form: n,e,s,w,u,d long form: north,east,south,west,up,down

Parameters:

dir - : Direction

getSteps

public java.lang.String[] getSteps()

Return the path steps as an array.

getStepsReverse

public java.lang.String[] getStepsReverse()

Return the paths reverse-direction steps.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCopy

public Path getCopy()

Get a copy of this object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object