Save This Page
Home » apache-harmony-6.0-src-r917296-snapshot » java » util » [javadoc | source]
java.util
public final class: UUID [javadoc | source]
java.lang.Object
   java.util.UUID

All Implemented Interfaces:
    Comparable, Serializable

UUID is an immutable representation of a 128-bit universally unique identifier (UUID).

There are multiple, variant layouts of UUIDs, but this class is based upon variant 2 of RFC 4122, the Leach-Salz variant. This class can be used to model alternate variants, but most of the methods will be unsupported in those cases; see each method for details.

Constructor:
 public UUID(long mostSigBits,
    long leastSigBits) 
Method from java.util.UUID Summary:
clockSequence,   compareTo,   equals,   fromString,   getLeastSignificantBits,   getMostSignificantBits,   hashCode,   nameUUIDFromBytes,   node,   randomUUID,   timestamp,   toString,   variant,   version
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.UUID Detail:
 public int clockSequence() 

    The clock sequence value of the version 1, variant 2 UUID as per RFC 4122.

 public int compareTo(UUID uuid) 

    Compares this UUID to the specified UUID. The natural ordering of UUIDs is based upon the value of the bits from most significant to least significant.

 public boolean equals(Object object) 

    Compares this UUID to another object for equality. If {@code object} is not {@code null}, is a UUID instance, and all bits are equal, then {@code true} is returned.

 public static UUID fromString(String uuid) 

    Parses a UUID string with the format defined by #toString() .

 public long getLeastSignificantBits() 

    The 64 least significant bits of the UUID.

 public long getMostSignificantBits() 

    The 64 most significant bits of the UUID.

 public int hashCode() 

    Returns a hash value for this UUID that is consistent with the #equals(Object) method.

 public static UUID nameUUIDFromBytes(byte[] name) 

    Generates a variant 2, version 3 (name-based, MD5-hashed) UUID as per RFC 4122.

 public long node() 

    The node value of the version 1, variant 2 UUID as per RFC 4122.

 public static UUID randomUUID() 

    Generates a variant 2, version 4 (randomly generated number) UUID as per RFC 4122.

 public long timestamp() 

    The timestamp value of the version 1, variant 2 UUID as per RFC 4122.

 public String toString() 

    Returns a string representation of this UUID in the following format, as per RFC 4122.

               UUID                   = time-low "-" time-mid "-"
                                        time-high-and-version "-"
                                        clock-seq-and-reserved
                                        clock-seq-low "-" node
               time-low               = 4hexOctet
               time-mid               = 2hexOctet
               time-high-and-version  = 2hexOctet
               clock-seq-and-reserved = hexOctet
               clock-seq-low          = hexOctet
               node                   = 6hexOctet
               hexOctet               = hexDigit hexDigit
               hexDigit =
                   "0" / "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9" /
                   "a" / "b" / "c" / "d" / "e" / "f" /
                   "A" / "B" / "C" / "D" / "E" / "F"
    
 public int variant() 

    The variant of the UUID as per RFC 4122.

    • 0 - Reserved for NCS compatibility
    • 2 - RFC 4122/Leach-Salz
    • 6 - Reserved for Microsoft Corporation compatibility
    • 7 - Reserved for future use
 public int version() 

    The version of the variant 2 UUID as per RFC 4122. If the variant is not 2, then the version will be 0.