UUID fields, as defined by RFC 4122
This interface defines the fields of an RFC 4122 variant UUID. Since RFC 9562 removed the concept of fields and
instead defined layouts that are specific to a given version, this interface is a legacy artifact of the earlier, and
now obsolete, RFC 4122.
The fields of an RFC 4122 variant UUID are:
-
time_low: The low field of the timestamp, an unsigned 32-bit integer
-
time_mid: The middle field of the timestamp, an unsigned 16-bit integer
-
time_hi_and_version: The high field of the timestamp multiplexed with the version number, an unsigned 16-bit integer
-
clock_seq_hi_and_reserved: The high field of the clock sequence multiplexed with the variant, an unsigned 8-bit integer
-
clock_seq_low: The low field of the clock sequence, an unsigned 8-bit integer
-
node: The spatially unique node identifier, an unsigned 48-bit integer
| Methods |
public
|
getClockSeq(): Hexadecimal
Returns the full 16-bit clock sequence, with the variant bits (two most significant bits) masked out
Returns the full 16-bit clock sequence, with the variant bits (two most significant bits) masked out
|
#
|
public
|
getClockSeqHiAndReserved(): Hexadecimal
Returns the high field of the clock sequence multiplexed with the variant
Returns the high field of the clock sequence multiplexed with the variant
|
#
|
public
|
getClockSeqLow(): Hexadecimal
Returns the low field of the clock sequence
Returns the low field of the clock sequence
|
#
|
public
|
getNode(): Hexadecimal
Returns the node field
|
#
|
public
|
getTimeHiAndVersion(): Hexadecimal
Returns the high field of the timestamp multiplexed with the version
Returns the high field of the timestamp multiplexed with the version
|
#
|
public
|
getTimeLow(): Hexadecimal
Returns the low field of the timestamp
Returns the low field of the timestamp
|
#
|
public
|
getTimeMid(): Hexadecimal
Returns the middle field of the timestamp
Returns the middle field of the timestamp
|
#
|
public
|
getTimestamp(): Hexadecimal
Returns the full 60-bit timestamp, without the version
Returns the full 60-bit timestamp, without the version
|
#
|
public
|
getVariant(): int
Returns the variant
Returns the variant
The variant number describes the layout of the UUID. The variant number has the following meaning:
- 0 - Reserved for NCS backward compatibility
- 2 - The RFC 9562 (formerly RFC 4122) variant
- 6 - Reserved, Microsoft Corporation backward compatibility
- 7 - Reserved for future definition
For RFC 9562 (formerly RFC 4122) variant UUIDs, this value should always be the integer 2.
|
#
|
public
|
getVersion(): ?int
Returns the UUID version
Returns the UUID version
The version number describes how the UUID was generated and has the following meaning:
- Gregorian time UUID
- DCE security UUID
- Name-based UUID hashed with MD5
- Randomly generated UUID
- Name-based UUID hashed with SHA-1
- Reordered Gregorian time UUID
- Unix Epoch time UUID
- Custom format UUID
This returns null if the UUID is not an RFC 9562 (formerly RFC 4122) variant, since the version is only
meaningful for this variant.
|
#
|
public
|
isNil(): bool
Returns true if these fields represent a nil UUID
Returns true if these fields represent a nil UUID
The nil UUID is a special form of UUID that is specified to have all 128 bits set to zero.
|
#
|