charger.obj

Class GraphObjectID

Object

charger.obj.GraphObjectID

public final class GraphObjectID
extends Object

Represents a graph object's ID. Although these are currently strings, it's helpful to have their own sub-class for type checking and for possible future enhancements. Regardless of the implementation, each new ID must be unique.

Author:

Harry S. Delugach (delugach@uah.edu)

Field Summary

Fields

Modifier and Type	Field and Description
private String	ident the string that is the unique identifier for an object.
static GraphObjectID	zero Represents an ident that is not attached to any object; e.g., if a graph has no owner ident.

Constructor Summary

Constructors

Constructor and Description
GraphObjectID() Create a new unique-to-the-universe id.
GraphObjectID(String s) Create an id from the given string.

Method Summary

Modifier and Type	Method and Description
boolean	equals(GraphObjectID other) Two objects are equal if their string representations are equal.
String	getShort() For debugging and other purposes, create a short version of the unique string representation.
String	toString() The string representation of this id.

Methods inherited from class Object

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

Field Detail

ident

private String ident

the string that is the unique identifier for an object. If constructed with a null string, then the string value is "-1".

zero

public static final GraphObjectID zero

Represents an ident that is not attached to any object; e.g., if a graph has no owner ident.

Constructor Detail

GraphObjectID

public GraphObjectID()

Create a new unique-to-the-universe id.

GraphObjectID

public GraphObjectID(String s)

Create an id from the given string. Note that this allows there to be more than one of any given id, thus violating the basic constraint. This assumes that the given string will have come from a properly-created GOID.

Parameters:

s -

Method Detail

toString

public String toString()

The string representation of this id.

Overrides:

toString in class Object

Returns:

A unique string representation of this id.

equals

public boolean equals(GraphObjectID other)

Two objects are equal if their string representations are equal.

Parameters:

other - the id to compare

Returns:

true if they are represented by the same string; false otherwise.

getShort

public String getShort()

For debugging and other purposes, create a short version of the unique string representation. Not necessarily unique across all implementations, but still locally useful.

Returns:

up to 6 characters of more-or-less distinct identifying information.