UUID (Waarp Common 3.0.12 API Reference)

java.lang.Object
- org.waarp.common.utility.UUID

All Implemented Interfaces:

Comparable<UUID>
```
public final class UUID
extends Object
implements Comparable<UUID>
```
UUID Generator (also Global UUID Generator)

Inspired from com.groupon locality-uuid which used combination of internal counter value - process id - fragment of MAC address and Timestamp. see https://github.com/groupon/locality-uuid.java

But force sequence and take care of errors and improves some performance issues

Author:

"Frederic Bregier"

Field Summary

Fields
Modifier and Type Field and Description

static int KEYSIZE
Native size of the UUID

Fields
Modifier and Type	Field and Description
`static int`	`KEYSIZE` Native size of the UUID

Constructor Summary

Constructors
Constructor and Description
`UUID()` Constructor that generates a new UUID using the current process id, MAC address, and timestamp
`UUID(boolean on128bits)` Create a UUID immediately compatible with a standard UUID implementation
`UUID(byte[] bytes)` Constructor that takes a byte array as this UUID's content
`UUID(int id)` Constructor that generates a new UUID using the current process id, MAC address, and timestamp
`UUID(long mostSigBits, long leastSigBits)` Create a UUID immediately compatible with a standard UUID implementation
`UUID(String idsource)` Build from String key
`UUID(UUID uuid)` Create a UUID immediately compatible with a standard UUID implementation

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(UUID arg0)`
`boolean`	`equals(Object o)`
`byte[]`	`getBytes()` copy the uuid of this UUID, so that it can't be changed, and return it
`int`	`getCounter()`
`int`	`getId()`
`UUID`	`getJavaUuid()`
`long`	`getLeastSignificantBits()`
`byte[]`	`getMacFragment()` extract MAC address fragment from raw UUID bytes, setting missing values to 0, from the active MAC address when the UUID was generated
`long`	`getMostSignificantBits()`
`int`	`getProcessId()` extract process id from raw UUID bytes and return as int
`static byte[]`	`getRandom(int length)`
`long`	`getTimestamp()` extract timestamp from raw UUID bytes and return as int
`int`	`getVersion()` extract version field as a hex char from raw UUID bytes
`int`	`hashCode()`
`byte[]`	`javaUuidGetBytes()` copy the uuid of this UUID, so that it can't be changed, and return it
`static int`	`jvmProcessId()`
`static byte[]`	`macAddress()`
`static void`	`main(String[] args)` Simply return a new UUID.
`protected UUID`	`setBytes(byte[] bytes)` Internal function
`static void`	`setMAC(byte[] mac)` Up to the 6 first bytes will be used.
`String`	`toBase64()`
`String`	`toHex()`
`String`	`toString()`

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

- Field Detail
  - KEYSIZE
```
public static final int KEYSIZE
```
    Native size of the UUID
    
    See Also:
    Constant Field Values
- Constructor Detail
  - UUID
```
public UUID()
```
    Constructor that generates a new UUID using the current process id, MAC address, and timestamp
  - UUID
```
public UUID(int id)
```
    Constructor that generates a new UUID using the current process id, MAC address, and timestamp
    
    Parameters:
    id - the id of the subset of UUID from which it belongs to (default being 0, else between 1 and 255)
  - UUID
```
public UUID(boolean on128bits)
```
    Create a UUID immediately compatible with a standard UUID implementation
    
    Parameters:
    on128bits - True for 128 bits limitation (16 Bytes instead of 20 Bytes)
  - UUID
```
public UUID(long mostSigBits,
    long leastSigBits)
```
    Create a UUID immediately compatible with a standard UUID implementation
    
    Parameters:
    mostSigBits -
    leastSigBits -
  - UUID
```
public UUID(UUID uuid)
```
    Create a UUID immediately compatible with a standard UUID implementation
    
    Parameters:
    uuid -
  - UUID
```
public UUID(byte[] bytes)
     throws RuntimeException
```
    Constructor that takes a byte array as this UUID's content
    
    Parameters:
    bytes - UUID content
    
    Throws:
    
    RuntimeException
  - UUID
```
public UUID(String idsource)
     throws RuntimeException
```
    Build from String key
    
    Parameters:
    idsource -
    
    Throws:
    
    RuntimeException
- Method Detail
  - setMAC
```
public static void setMAC(byte[] mac)
```
    Up to the 6 first bytes will be used. If Null or less than 6 bytes, extra bytes will be randomly generated.
    
    Parameters:
    mac - the MAC address in byte format (up to the 6 first bytes will be used)
  - setBytes
```
protected UUID setBytes(byte[] bytes)
                 throws RuntimeException
```
    Internal function
    
    Parameters:
    bytes -
    
    Returns:
    
    Throws:
    
    RuntimeException
  - toBase64
```
public final String toBase64()
```
  - toHex
```
public final String toHex()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBytes
```
public byte[] getBytes()
```
    copy the uuid of this UUID, so that it can't be changed, and return it
    
    Returns:
    raw byte array of UUID
  - getVersion
```
public final int getVersion()
```
    extract version field as a hex char from raw UUID bytes
    
    Returns:
    version char
  - getId
```
public final int getId()
```
    Returns:
    the id of the subset of UUID from which it belongs to (default being 0)
  - getProcessId
```
public final int getProcessId()
```
    extract process id from raw UUID bytes and return as int
    
    Returns:
    id of process that generated the UUID, or -1 for unrecognized format
  - getCounter
```
public final int getCounter()
```
    Returns:
    the associated counter value
  - getTimestamp
```
public final long getTimestamp()
```
    extract timestamp from raw UUID bytes and return as int
    
    Returns:
    millisecond UTC timestamp from generation of the UUID, or -1 for unrecognized format
  - getMacFragment
```
public final byte[] getMacFragment()
```
    extract MAC address fragment from raw UUID bytes, setting missing values to 0, from the active MAC address when the UUID was generated
    
    Returns:
    byte array of UUID fragment, or null for unrecognized format
  - getLeastSignificantBits
```
public long getLeastSignificantBits()
```
    Returns:
    the least significant bits (as in standard UUID implementation)
  - getMostSignificantBits
```
public long getMostSignificantBits()
```
    Returns:
    the most significant bits (as in standard UUID implementation)
  - getJavaUuid
```
public UUID getJavaUuid()
```
    Returns:
    a UUID compatible with Java.Util package implementation
  - javaUuidGetBytes
```
public byte[] javaUuidGetBytes()
```
    copy the uuid of this UUID, so that it can't be changed, and return it
    
    Returns:
    raw byte array of UUID for a 16 Bytes UUID
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getRandom
```
public static final byte[] getRandom(int length)
```
    Parameters:
    length -
    
    Returns:
    a byte array with random values
  - macAddress
```
public static byte[] macAddress()
```
    Returns:
    the mac address if possible, else random values
  - jvmProcessId
```
public static int jvmProcessId()
```
    Returns:
    the JVM Process ID
  - compareTo
```
public int compareTo(UUID arg0)
```
    Specified by:
    
    compareTo in interface Comparable<UUID>
  - main
```
public static void main(String[] args)
```
    Simply return a new UUID. If an argument is provided, 2 cases occur:
    - length <= 3 = same as UUID(int) - length > 3 = same as checking the given UUID in String format
    
    Parameters:
    args -

Class UUID

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEYSIZE

Constructor Detail

UUID

UUID

UUID

UUID

UUID

UUID

UUID

Method Detail

setMAC

setBytes

toBase64

toHex

toString

getBytes

getVersion

getId

getProcessId

getCounter

getTimestamp

getMacFragment

getLeastSignificantBits

getMostSignificantBits

getJavaUuid

javaUuidGetBytes

equals

hashCode

getRandom

macAddress

jvmProcessId

compareTo

main