org.jboss.util.id: public class: GUID

org.jboss.util.id
public class: GUID [javadoc | source]

java.lang.Object
   org.jboss.util.id.GUID

All Implemented Interfaces:
ID

A globally unique identifier (globally across a cluster of virtual machines).

The identifier is composed of:

The VMID for the virtual machine.
A UID to provide uniqueness over a VMID.

[ address ] - [ process id ] - [ time ] - [ counter ] - [ time ] - [ counter ]
|------- UID --------| |------- UID --------|
|---------------------- VMID -----------------------|

Also see:

VMID

UID

version: < - tt>$Revision: 1.1 $

author: < - a href="mailto:jason@planet57.com">Jason Dillon

Field Summary
protected final VMID	vmid	The virtual machine identifier
protected final UID	uid	The unique identifier
protected final int	hashCode	The hash code of this GUID

Constructor:

Constructor:
public GUID() { this.vmid = VMID.getInstance(); this.uid = new UID(); // generate a hash code for this GUID int code = vmid.hashCode(); code ^= uid.hashCode(); hashCode = code; } Construct a new GUID.
protected GUID(GUID guid) { this.vmid = guid.vmid; this.uid = guid.uid; this.hashCode = guid.hashCode; } Copy a GUID. Parameters: `guid` - GUID to copy.

 public GUID() {
      this.vmid = VMID.getInstance();
      this.uid = new UID();
      // generate a hash code for this GUID
      int code = vmid.hashCode();
      code ^= uid.hashCode();
      hashCode = code;
}

Construct a new GUID.

 protected GUID(GUID guid) {
      this.vmid = guid.vmid;
      this.uid = guid.uid;
      this.hashCode = guid.hashCode;
}

Copy a GUID.

Parameters:

guid - GUID to copy.

Method from org.jboss.util.id.GUID Summary:
asString, clone, equals, getUID, getVMID, hashCode, toString

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jboss.util.id.GUID Detail:
public static String asString() { return new GUID().toString(); } Returns a GUID as a string.
public Object clone() { try { return super.clone(); } catch (CloneNotSupportedException e) { throw new InternalError(); } } Returns a copy of this GUID.
public boolean equals(Object obj) { if (obj == this) return true; if (obj != null && obj.getClass() == getClass()) { GUID guid = (GUID)obj; return guid.vmid.equals(vmid) && guid.uid.equals(uid); } return false; } Check if the given object is equal to this GUID. A GUID is equal to another GUID if the VMID and UID portions are equal.
public final UID getUID() { return uid; } Get the UID portion of this GUID.
public final VMID getVMID() { return vmid; } Get the VMID portion of this GUID.
public int hashCode() { return hashCode; } Return the hash code of this GUID.
public String toString() { return vmid.toString() + "-" + uid.toString(); } Return a string representation of this GUID.

Method from org.jboss.util.id.GUID Detail:

 public static String asString() {
      return new GUID().toString();
}

Returns a GUID as a string.

 public Object clone() {
      try {
         return super.clone();
      }
      catch (CloneNotSupportedException e) {
         throw new InternalError();
      }
}

Returns a copy of this GUID.

 public boolean equals(Object obj) {
      if (obj == this) return true;
      if (obj != null && obj.getClass() == getClass()) {
         GUID guid = (GUID)obj;
         return 
            guid.vmid.equals(vmid) &&
            guid.uid.equals(uid);
      }
      return false;
}

A GUID is equal to another GUID if the VMID and UID portions are equal.

 public final UID getUID() {
      return uid;
}

Get the UID portion of this GUID.

 public final VMID getVMID() {
      return vmid;
}

Get the VMID portion of this GUID.

 public int hashCode() {
      return hashCode;
}

Return the hash code of this GUID.

 public String toString() {
      return vmid.toString() + "-" + uid.toString();
}

Return a string representation of this GUID.