org.gjt.universe
Class WormholeID

java.lang.Object
  |
  +--org.gjt.universe.Index
        |
        +--org.gjt.universe.WormholeID

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class WormholeID

extends Index

This class is used for unique IDs to access Wormhole objects in the database.

See Also:

Wormhole, Serialized Form

Field Summary

static WormholeID

UNDEFINED

Fields inherited from class org.gjt.universe.Index

Constructor Summary

WormholeID()
This constructor method returns an instance equivalent to WormholeID.UNDEFINED and thus should not be called directly.

WormholeID(int in)
This method returns a new WormholeID instances based on the given integer value.

Method Summary

DisplayNodeColor	getDisplayNodeColor(CivID AID) Returns the color surrounding the image in the tree.
java.lang.String	getDisplayNodeImage() Returns the Image used in the display tree
java.lang.String	getDisplayNodeMessage() Returns the message displayed in the tree for this Index.
DBItem	getItem() Returns the object from the database that this index is pointing.

Methods inherited from class org.gjt.universe.Index

equals, get, getDisplayNodeChildren, hashCode, increment, set, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static WormholeID UNDEFINED

Constructor Detail

WormholeID

public WormholeID()

This constructor method returns an instance equivalent to WormholeID.UNDEFINED and thus should not be called directly.

WormholeID

public WormholeID(int in)

This method returns a new WormholeID instances based on the given integer value.

Method Detail

getItem

public DBItem getItem()

Deprecated. Use WormholeList.get() instead

Description copied from class: Index

Returns the object from the database that this index is pointing.

Specified by:

getItem in class Index

getDisplayNodeMessage

public java.lang.String getDisplayNodeMessage()

Description copied from class: Index

Returns the message displayed in the tree for this Index.

Specified by:

getDisplayNodeMessage in class Index

See Also:

GUIDisplayTreeJFC

getDisplayNodeImage

public java.lang.String getDisplayNodeImage()

Description copied from class: Index

Returns the Image used in the display tree

Overrides:

getDisplayNodeImage in class Index

See Also:

GUIDisplayTreeJFC

getDisplayNodeColor

public DisplayNodeColor getDisplayNodeColor(CivID AID)

Description copied from class: Index

Returns the color surrounding the image in the tree.

Overrides:

getDisplayNodeColor in class Index

Parameters:

AID - The viewer of this tree.

See Also:

GUIDisplayTreeJFC