Methods Summary |
---|
public int | clockSequence()The clock sequence value associated with this UUID.
The 14 bit clock sequence value is constructed from the clock
sequence field of this UUID. The clock sequence field is used to
guarantee temporal uniqueness in a time-based UUID.
The clockSequence value is only meaningful in a time-based UUID, which
has version type 1. If this UUID is not a time-based UUID then
this method throws UnsupportedOperationException.
if (version() != 1) {
throw new UnsupportedOperationException("Not a time-based UUID");
}
if (sequence < 0) {
sequence = (int)((leastSigBits & 0x3FFF000000000000L) >>> 48);
}
return sequence;
|
public int | compareTo(java.util.UUID val)Compares this UUID with the specified UUID.
The first of two UUIDs follows the second if the most significant
field in which the UUIDs differ is greater for the first UUID.
// The ordering is intentionally set up so that the UUIDs
// can simply be numerically compared as two numbers
return (this.mostSigBits < val.mostSigBits ? -1 :
(this.mostSigBits > val.mostSigBits ? 1 :
(this.leastSigBits < val.leastSigBits ? -1 :
(this.leastSigBits > val.leastSigBits ? 1 :
0))));
|
private static java.lang.String | digits(long val, int digits)Returns val represented by the specified number of hex digits.
long hi = 1L << (digits * 4);
return Long.toHexString(hi | (val & (hi - 1))).substring(1);
|
public boolean | equals(java.lang.Object obj)Compares this object to the specified object. The result is
true if and only if the argument is not
null, is a UUID object, has the same variant,
and contains the same value, bit for bit, as this UUID.
if (!(obj instanceof UUID))
return false;
if (((UUID)obj).variant() != this.variant())
return false;
UUID id = (UUID)obj;
return (mostSigBits == id.mostSigBits &&
leastSigBits == id.leastSigBits);
|
public static java.util.UUID | fromString(java.lang.String name)Creates a UUID from the string standard representation as
described in the {@link #toString} method.
String[] components = name.split("-");
if (components.length != 5)
throw new IllegalArgumentException("Invalid UUID string: "+name);
for (int i=0; i<5; i++)
components[i] = "0x"+components[i];
long mostSigBits = Long.decode(components[0]).longValue();
mostSigBits <<= 16;
mostSigBits |= Long.decode(components[1]).longValue();
mostSigBits <<= 16;
mostSigBits |= Long.decode(components[2]).longValue();
long leastSigBits = Long.decode(components[3]).longValue();
leastSigBits <<= 48;
leastSigBits |= Long.decode(components[4]).longValue();
return new UUID(mostSigBits, leastSigBits);
|
public long | getLeastSignificantBits()Returns the least significant 64 bits of this UUID's 128 bit value.
return leastSigBits;
|
public long | getMostSignificantBits()Returns the most significant 64 bits of this UUID's 128 bit value.
return mostSigBits;
|
public int | hashCode()Returns a hash code for this UUID .
if (hashCode == -1) {
hashCode = (int)((mostSigBits >> 32) ^
mostSigBits ^
(leastSigBits >> 32) ^
leastSigBits);
}
return hashCode;
|
public static java.util.UUID | nameUUIDFromBytes(byte[] name)Static factory to retrieve a type 3 (name based) UUID based on
the specified byte array.
MessageDigest md;
try {
md = MessageDigest.getInstance("MD5");
} catch (NoSuchAlgorithmException nsae) {
throw new InternalError("MD5 not supported");
}
byte[] md5Bytes = md.digest(name);
md5Bytes[6] &= 0x0f; /* clear version */
md5Bytes[6] |= 0x30; /* set to version 3 */
md5Bytes[8] &= 0x3f; /* clear variant */
md5Bytes[8] |= 0x80; /* set to IETF variant */
return new UUID(md5Bytes);
|
public long | node()The node value associated with this UUID.
The 48 bit node value is constructed from the node field of
this UUID. This field is intended to hold the IEEE 802 address
of the machine that generated this UUID to guarantee spatial
uniqueness.
The node value is only meaningful in a time-based UUID, which
has version type 1. If this UUID is not a time-based UUID then
this method throws UnsupportedOperationException.
if (version() != 1) {
throw new UnsupportedOperationException("Not a time-based UUID");
}
if (node < 0) {
node = leastSigBits & 0x0000FFFFFFFFFFFFL;
}
return node;
|
public static java.util.UUID | randomUUID()Static factory to retrieve a type 4 (pseudo randomly generated) UUID.
The UUID is generated using a cryptographically strong
pseudo random number generator.
SecureRandom ng = numberGenerator;
if (ng == null) {
numberGenerator = ng = new SecureRandom();
}
byte[] randomBytes = new byte[16];
ng.nextBytes(randomBytes);
randomBytes[6] &= 0x0f; /* clear version */
randomBytes[6] |= 0x40; /* set to version 4 */
randomBytes[8] &= 0x3f; /* clear variant */
randomBytes[8] |= 0x80; /* set to IETF variant */
UUID result = new UUID(randomBytes);
return new UUID(randomBytes);
|
private void | readObject(java.io.ObjectInputStream in)Reconstitute the UUID instance from a stream (that is,
deserialize it). This is necessary to set the transient fields
to their correct uninitialized value so they will be recomputed
on demand.
in.defaultReadObject();
// Set "cached computation" fields to their initial values
version = -1;
variant = -1;
timestamp = -1;
sequence = -1;
node = -1;
hashCode = -1;
|
public long | timestamp()The timestamp value associated with this UUID.
The 60 bit timestamp value is constructed from the time_low,
time_mid, and time_hi fields of this UUID. The resulting
timestamp is measured in 100-nanosecond units since midnight,
October 15, 1582 UTC.
The timestamp value is only meaningful in a time-based UUID, which
has version type 1. If this UUID is not a time-based UUID then
this method throws UnsupportedOperationException.
if (version() != 1) {
throw new UnsupportedOperationException("Not a time-based UUID");
}
long result = timestamp;
if (result < 0) {
result = (mostSigBits & 0x0000000000000FFFL) << 48;
result |= ((mostSigBits >> 16) & 0xFFFFL) << 32;
result |= mostSigBits >>> 32;
timestamp = result;
}
return result;
|
public java.lang.String | toString()Returns a String object representing this
UUID .
The UUID string representation is as described by this BNF :
UUID = "-" "-"
"-"
"-"
time_low = 4*
time_mid = 2*
time_high_and_version = 2*
variant_and_sequence = 2*
node = 6*
hexOctet =
hexDigit =
"0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
| "a" | "b" | "c" | "d" | "e" | "f"
| "A" | "B" | "C" | "D" | "E" | "F"
return (digits(mostSigBits >> 32, 8) + "-" +
digits(mostSigBits >> 16, 4) + "-" +
digits(mostSigBits, 4) + "-" +
digits(leastSigBits >> 48, 4) + "-" +
digits(leastSigBits, 12));
|
public int | variant()The variant number associated with this UUID. The variant
number describes the layout of the UUID.
The variant number has the following meaning:
- 0 Reserved for NCS backward compatibility
- 2 The Leach-Salz variant (used by this class)
- 6 Reserved, Microsoft Corporation backward compatibility
- 7 Reserved for future definition
if (variant < 0) {
// This field is composed of a varying number of bits
if ((leastSigBits >>> 63) == 0) {
variant = 0;
} else if ((leastSigBits >>> 62) == 2) {
variant = 2;
} else {
variant = (int)(leastSigBits >>> 61);
}
}
return variant;
|
public int | version()The version number associated with this UUID. The version
number describes how this UUID was generated.
The version number has the following meaning:
- 1 Time-based UUID
- 2 DCE security UUID
- 3 Name-based UUID
- 4 Randomly generated UUID
if (version < 0) {
// Version is bits masked by 0x000000000000F000 in MS long
version = (int)((mostSigBits >> 12) & 0x0f);
}
return version;
|