UuidUtil (uuid-creator 1.4.0 API)

java.lang.Object
- com.github.f4b6a3.uuid.util.UuidUtil

```
public class UuidUtil
extends Object
```

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`extractClockSequence(UUID uuid)` Get the clock sequence that is embedded in the UUID.
`static Instant`	`extractDceSecurityInstant(UUID uuid)` Get the instant that is embedded in the DCE Security UUID.
`static byte`	`extractDceSecurityLocalDomain(UUID uuid)` Get the local domain number that is embedded in the DCE Security UUID.
`static int`	`extractDceSecurityLocalIdentifier(UUID uuid)` Get the local identifier number that is embedded in the DCE Security UUID.
`static long`	`extractDceSecurityTimestamp(UUID uuid)` Get the timestamp that is embedded in the DCE Security UUID.
`static Instant`	`extractInstant(UUID uuid)` Get the instant that is embedded in the UUID.
`static long`	`extractNodeIdentifier(UUID uuid)` Get the node identifier that is embedded in the UUID.
`static long`	`extractTimestamp(UUID uuid)` Get the timestamp that is embedded in the UUID.
`static long`	`extractUnixEpochMilliseconds(UUID uuid)` Get the Unix epoch milliseconds that is embedded in the UUID.
`static long`	`formatMssqlMostSignificantBits(long timestamp)` Format most significant bits for MSSQL Server. ### References * How to Generate Sequential GUIDs for SQL Server in .NET https://blogs.msdn.microsoft.com/dbrowne/2012/07/03/how-to-generate-sequential-guids-for-sql-server-in-net/ * UUID Binary encoding https://en.wikipedia.org/wiki/Universally_unique_identifier#Encoding * Newsequentialid (Histrory/Benefits and Implementation) https://blogs.msdn.microsoft.com/sqlprogrammability/2006/03/23/newsequentialid-histrorybenefits-and-implementation/ * NEWSEQUENTIALID (Transact-SQL) https://docs.microsoft.com/en-us/sql/t-sql/functions/newsequentialid-transact-sql?
`static long`	`formatRfc4122LeastSignificantBits(long nodeIdentifier, long clockSequence)` Returns the least significant bits of the UUID. ### RFC-4122 - 4.2.2.
`static long`	`formatSequentialMostSignificantBits(long timestamp)` Returns the timestamp bits of the UUID in the 'natural' order of bytes.
`static long`	`formatTimeBasedMostSignificantBits(long timestamp)` Returns the timestamp bits of the UUID in the order defined in the RFC-4122. ### RFC-4122 - 4.2.2.
`static UUID`	`fromBytesToUuid(byte[] bytes)` Get a UUID from an array of bytes;
`static UUID`	`fromMssqlGuidToUuid(UUID uuid)` Convert a MSSQL Server 'friendly' GUID to a UUID.
`static UUID`	`fromSequentialUuidToTimeBasedUuid(UUID uuid)` Convert a sequential UUID to a time-based UUID.
`static UUID`	`fromTimeBasedUuidToSequentialUuid(UUID uuid)` Convert a time-based UUID to a sequential UUID.
`static byte[]`	`fromUuidToBytes(UUID uuid)` Get the array of bytes from a UUID.
`static UUID`	`fromUuidToMssqlGuid(UUID uuid)` Convert a UUID to a MSSQL Server 'friendly' GUID.
`UuidVersion`	`getVersion(UUID uuid)` Get the UUID version.
`static boolean`	`isDceSecurityVersion(UUID uuid)` Checks whether the UUID version 2.
`static boolean`	`isNameBasedVersion(UUID uuid)` Checks whether the UUID version 3 or 5.
`static boolean`	`isRandomBasedVersion(UUID uuid)` Checks whether the UUID version 4.
`static boolean`	`isRfc4122Variant(UUID uuid)` Checks whether the UUID variant is the one defined by the RFC-4122.
`static boolean`	`isSequentialVersion(UUID uuid)` Checks whether the UUID version 0.
`static boolean`	`isTimeBasedVersion(UUID uuid)` Checks whether the UUID version 1.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getVersion
```
public UuidVersion getVersion(UUID uuid)
```
    Get the UUID version.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    a UuidVersion
  - isRfc4122Variant
```
public static boolean isRfc4122Variant(UUID uuid)
```
    Checks whether the UUID variant is the one defined by the RFC-4122.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    boolean true if it is an RFC4122 variant
  - isRandomBasedVersion
```
public static boolean isRandomBasedVersion(UUID uuid)
```
    Checks whether the UUID version 4.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    boolean true if it is a random UUID
  - isNameBasedVersion
```
public static boolean isNameBasedVersion(UUID uuid)
```
    Checks whether the UUID version 3 or 5.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    boolean true if it is a name-based UUID
  - isTimeBasedVersion
```
public static boolean isTimeBasedVersion(UUID uuid)
```
    Checks whether the UUID version 1.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    boolean true if it is a time-based UUID
  - isSequentialVersion
```
public static boolean isSequentialVersion(UUID uuid)
```
    Checks whether the UUID version 0.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    boolean true if it is a sequential UUID
  - isDceSecurityVersion
```
public static boolean isDceSecurityVersion(UUID uuid)
```
    Checks whether the UUID version 2.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    boolean true if it is a DCE Security UUID
  - extractNodeIdentifier
```
public static long extractNodeIdentifier(UUID uuid)
```
    Get the node identifier that is embedded in the UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    long the node identifier
  - extractClockSequence
```
public static int extractClockSequence(UUID uuid)
```
    Get the clock sequence that is embedded in the UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    int the clock sequence
  - extractInstant
```
public static Instant extractInstant(UUID uuid)
```
    Get the instant that is embedded in the UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    Instant
  - extractUnixEpochMilliseconds
```
public static long extractUnixEpochMilliseconds(UUID uuid)
```
    Get the Unix epoch milliseconds that is embedded in the UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    epoch milliseconds
  - extractTimestamp
```
public static long extractTimestamp(UUID uuid)
```
    Get the timestamp that is embedded in the UUID. The timestamps returned by this method are the number of 100-nanos since Gregorian Epoch.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    long the timestamp
  - extractDceSecurityLocalDomain
```
public static byte extractDceSecurityLocalDomain(UUID uuid)
```
    Get the local domain number that is embedded in the DCE Security UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    the local domain
  - extractDceSecurityLocalIdentifier
```
public static int extractDceSecurityLocalIdentifier(UUID uuid)
```
    Get the local identifier number that is embedded in the DCE Security UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    the local identifier
  - extractDceSecurityTimestamp
```
public static long extractDceSecurityTimestamp(UUID uuid)
```
    Get the timestamp that is embedded in the DCE Security UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    the timestamp
  - extractDceSecurityInstant
```
public static Instant extractDceSecurityInstant(UUID uuid)
```
    Get the instant that is embedded in the DCE Security UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    Instant
  - fromUuidToBytes
```
public static byte[] fromUuidToBytes(UUID uuid)
```
    Get the array of bytes from a UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    an array of bytes
  - fromBytesToUuid
```
public static UUID fromBytesToUuid(byte[] bytes)
```
    Get a UUID from an array of bytes;
    
    Parameters:
    
    bytes - an array of bytes
    
    Returns:
    
    a UUID
  - fromSequentialUuidToTimeBasedUuid
```
public static UUID fromSequentialUuidToTimeBasedUuid(UUID uuid)
```
    Convert a sequential UUID to a time-based UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    another UUID
  - fromTimeBasedUuidToSequentialUuid
```
public static UUID fromTimeBasedUuidToSequentialUuid(UUID uuid)
```
    Convert a time-based UUID to a sequential UUID.
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    another UUID
  - fromUuidToMssqlGuid
```
public static UUID fromUuidToMssqlGuid(UUID uuid)
```
    Convert a UUID to a MSSQL Server 'friendly' GUID. formatMssqlMostSignificantBits(long)
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    another UUID
  - fromMssqlGuidToUuid
```
public static UUID fromMssqlGuidToUuid(UUID uuid)
```
    Convert a MSSQL Server 'friendly' GUID to a UUID. formatMssqlMostSignificantBits(long)
    
    Parameters:
    
    uuid - an UUID
    
    Returns:
    
    another UUID
  - formatSequentialMostSignificantBits
```
public static long formatSequentialMostSignificantBits(long timestamp)
```
    Returns the timestamp bits of the UUID in the 'natural' order of bytes. It's not necessary to set the version bits because they are already ZERO.
    
    Parameters:
    
    timestamp - a timestamp
    
    Returns:
    
    the MSB
  - formatTimeBasedMostSignificantBits
```
public static long formatTimeBasedMostSignificantBits(long timestamp)
```
    Returns the timestamp bits of the UUID in the order defined in the RFC-4122. ### RFC-4122 - 4.2.2. Generation Details Determine the values for the UTC-based timestamp and clock sequence to be used in the UUID, as described in Section 4.2.1. For the purposes of this algorithm, consider the timestamp to be a 60-bit unsigned integer and the clock sequence to be a 14-bit unsigned integer. Sequentially number the bits in a field, starting with zero for the least significant bit. "Set the time_low field equal to the least significant 32 bits (bits zero through 31) of the timestamp in the same order of significance. Set the time_mid field equal to bits 32 through 47 from the timestamp in the same order of significance. Set the 12 least significant bits (bits zero through 11) of the time_hi_and_version field equal to bits 48 through 59 from the timestamp in the same order of significance. Set the four most significant bits (bits 12 through 15) of the time_hi_and_version field to the 4-bit version number corresponding to the UUID version being created, as shown in the table above."
    
    Parameters:
    
    timestamp - a timestamp
    
    Returns:
    
    the MSB
  - formatMssqlMostSignificantBits
```
public static long formatMssqlMostSignificantBits(long timestamp)
```
    Format most significant bits for MSSQL Server. ### References * How to Generate Sequential GUIDs for SQL Server in .NET https://blogs.msdn.microsoft.com/dbrowne/2012/07/03/how-to-generate-sequential-guids-for-sql-server-in-net/ * UUID Binary encoding https://en.wikipedia.org/wiki/Universally_unique_identifier#Encoding * Newsequentialid (Histrory/Benefits and Implementation) https://blogs.msdn.microsoft.com/sqlprogrammability/2006/03/23/newsequentialid-histrorybenefits-and-implementation/ * NEWSEQUENTIALID (Transact-SQL) https://docs.microsoft.com/en-us/sql/t-sql/functions/newsequentialid-transact-sql?view=sql-server-2017 * How are GUIDs sorted by SQL Server? http://sqlblog.com/blogs/alberto_ferrari/archive/2007/08/31/how-are-guids-sorted-by-sql-server.aspx * SqlGuid.CompareTo Method https://docs.microsoft.com/en-us/dotnet/api/system.data.sqltypes.sqlguid.compareto?view=netframework-4.7.2#System_Data_SqlTypes_SqlGuid_CompareTo_System_Data_SqlTypes_SqlGuid_ * Comparing GUID and uniqueidentifier Values https://docs.microsoft.com/pt-br/dotnet/framework/data/adonet/sql/comparing-guid-and-uniqueidentifier-values
    
    Parameters:
    
    timestamp - a timestamp
    
    Returns:
    
    the MSB
  - formatRfc4122LeastSignificantBits
```
public static long formatRfc4122LeastSignificantBits(long nodeIdentifier,
                                                     long clockSequence)
```
    Returns the least significant bits of the UUID. ### RFC-4122 - 4.2.2. Generation Details Set the clock_seq_low field to the eight least significant bits (bits zero through 7) of the clock sequence in the same order of significance. Set the 6 least significant bits (bits zero through 5) of the clock_seq_hi_and_reserved field to the 6 most significant bits (bits 8 through 13) of the clock sequence in the same order of significance. Set the two most significant bits (bits 6 and 7) of the clock_seq_hi_and_reserved to zero and one, respectively. Set the node field to the 48-bit IEEE address in the same order of significance as the address.
    
    Parameters:
    
    nodeIdentifier - a node identifier
    
    clockSequence - a clock sequence
    
    Returns:
    
    the LSB

Class UuidUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getVersion

isRfc4122Variant

isRandomBasedVersion

isNameBasedVersion

isTimeBasedVersion

isSequentialVersion

isDceSecurityVersion

extractNodeIdentifier

extractClockSequence

extractInstant

extractUnixEpochMilliseconds

extractTimestamp

extractDceSecurityLocalDomain

extractDceSecurityLocalIdentifier

extractDceSecurityTimestamp

extractDceSecurityInstant

fromUuidToBytes

fromBytesToUuid

fromSequentialUuidToTimeBasedUuid

fromTimeBasedUuidToSequentialUuid

fromUuidToMssqlGuid

fromMssqlGuidToUuid

formatSequentialMostSignificantBits

formatTimeBasedMostSignificantBits

formatMssqlMostSignificantBits

formatRfc4122LeastSignificantBits