Package anecho.JamochaMUD

Class World

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

anecho.gui.EasyIconTreeNode

anecho.JamochaMUD.World

public class World
extends EasyIconTreeNode

This class is used to store information about Worlds in JamochaMUD. It is a extends a node so that it can easily be added and manipulated in a JTree.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

Constructors

Constructor	Description
World()	The constructor for the World class.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAddress()
java.lang.String	getCodePage()	This method returns a code-page if the world over-rides the standard code-page
javax.swing.Icon	getIcon()	Returns the icon assigned to this node.
int	getLoginStyle()
java.lang.String	getNotes()
int	getPort()
long	getWorldID()	Returns an ID unique to this world.
java.lang.String	getWorldName()
boolean	isAutoLogin()
boolean	isOverride()	This method reports whether the standard code-page has been over-ridden
boolean	isSSL()
boolean	isValidWorld()	This is a simple test to see if the world contains the barest minimum to connect to a MU*
void	setAddress(java.lang.String addy)
void	setCodePage(java.lang.String codePage)	This method allows the code-page to be set, indicating that this world is to over-ride the standard code-page.
void	setLoginStyle(int style)
void	setNotes(java.lang.String notes)
void	setOverride(boolean override)	This method sets whether the code-page has been over-ridden or not.
void	setPort(int port)
void	setSSL(boolean state)
void	setWorldID(long newID)	This method should only be used if setting up a previously existing world.
void	setWorldName(java.lang.String newName)
java.lang.String	toString()	Return a string listing the name, address, and port
void	useAutoLogin(boolean state)

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class anecho.gui.EasyIconTreeNode

setIcon

Methods inherited from class java.lang.Object

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

Constructor Detail

World

public World()

The constructor for the World class.

Method Detail

setWorldName

public void setWorldName(java.lang.String newName)

Parameters:

newName -

getWorldName

public java.lang.String getWorldName()

Returns:

setAddress

public void setAddress(java.lang.String addy)

Parameters:

addy -

getAddress

public java.lang.String getAddress()

Returns:

setPort

public void setPort(int port)

Parameters:

port -

getPort

public int getPort()

Returns:

getWorldID

public long getWorldID()

Returns an ID unique to this world. The ID is generated by this class upon creation of a new world, and cannot be altered. This should help avoid "book-keeping" headaches.

Returns:

setWorldID

public void setWorldID(long newID)

This method should only be used if setting up a previously existing world. Otherwise a unique WorldID is set during the creation of a World object.

Parameters:

newID -

setSSL

public void setSSL(boolean state)

Parameters:

state -

isSSL

public boolean isSSL()

Returns:

useAutoLogin

public void useAutoLogin(boolean state)

Parameters:

state -

isAutoLogin

public boolean isAutoLogin()

Returns:

setLoginStyle

public void setLoginStyle(int style)

Parameters:

style -

getLoginStyle

public int getLoginStyle()

Returns:

setNotes

public void setNotes(java.lang.String notes)

Parameters:

notes -

getNotes

public java.lang.String getNotes()

Returns:

getIcon

public javax.swing.Icon getIcon()

Description copied from class: EasyIconTreeNode

Returns the icon assigned to this node.

Overrides:

getIcon in class EasyIconTreeNode

Returns:

toString

public java.lang.String toString()

Return a string listing the name, address, and port

Overrides:

toString in class javax.swing.tree.DefaultMutableTreeNode

Returns:

getCodePage

public java.lang.String getCodePage()

This method returns a code-page if the world over-rides the standard code-page

Returns:

The code page to use. If this world does not over-ride a code page, it will return null.

setCodePage

public void setCodePage(java.lang.String codePage)

This method allows the code-page to be set, indicating that this world is to over-ride the standard code-page.

Parameters:

codePage - The codepage to set, in the format of "cp1452"

isOverride

public boolean isOverride()

This method reports whether the standard code-page has been over-ridden

Returns:

true The code-page over-ride has been enabled false The code-page over-ride has not been enabled

setOverride

public void setOverride(boolean override)

This method sets whether the code-page has been over-ridden or not.

Parameters:

override - true The code-page should be over-ridden false The code-page should not be over-ridden

isValidWorld

public boolean isValidWorld()

This is a simple test to see if the world contains the barest minimum to connect to a MU*

Returns: