GUID (Waarp Common 3.3.4 API Reference)

java.lang.Object
- org.waarp.common.guid.GUID

All Implemented Interfaces:: Comparable<GUID>

public class GUID
extends Object
implements Comparable<GUID>

Field Summary

Fields
Modifier and Type Field and Description

static String ARK
ARK header

Fields
Modifier and Type	Field and Description
`static String`	`ARK` ARK header

Constructor Summary

Constructors
Constructor and Description
`GUID()` Constructor that generates a new GUID using the current process id, Platform Id and timestamp with no tenant
`GUID(byte[] bytes)` Constructor that takes a byte array as this GUID's content
`GUID(int tenantId, int platformId)` Constructor that generates a new GUID using the current process id and timestamp
`GUID(String idsource)` Build from String key

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(GUID guid)`
`boolean`	`equals(Object o)`
`byte[]`	`getBytes()` copy the uuid of this GUID, so that it can't be changed, and return it
`int`	`getCounter()`
`String`	`getId()`
`static int`	`getKeySize()`
`byte[]`	`getMacFragment()` Extract Platform id as bytes.
`int`	`getPlatformId()` Extract Platform id as int.
`int`	`getProcessId()` Extract process id and return as int
`int`	`getTenantId()`
`long`	`getTimestamp()` Extract timestamp and return as long
`int`	`getVersion()` extract version field as a hex char from raw GUID bytes
`int`	`hashCode()`
`String`	`toArk()`
`String`	`toArkName()`
`String`	`toBase32()`
`String`	`toBase64()`
`String`	`toHex()`
`String`	`toString()`

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

- Field Detail
  - ARK
```
public static final String ARK
```
    ARK header
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GUID
```
public GUID(byte[] bytes)
     throws InvalidArgumentException
```
    Constructor that takes a byte array as this GUID's content
    
    Parameters:
    
    bytes - GUID content
    
    Throws:
    
    InvalidArgumentException
  - GUID
```
public GUID(String idsource)
     throws InvalidArgumentException
```
    Build from String key
    
    Parameters:
    
    idsource -
    
    Throws:
    
    InvalidArgumentException
  - GUID
```
public GUID()
```
    Constructor that generates a new GUID using the current process id, Platform Id and timestamp with no tenant
  - GUID
```
public GUID(int tenantId,
            int platformId)
```
    Constructor that generates a new GUID using the current process id and timestamp
    
    Parameters:
    
    tenantId - tenant id between 0 and 2^30-1
    
    platformId - platform Id between 0 and 2^31-1
    
    Throws:
    
    IllegalArgumentException - if any of the argument are out of range
- Method Detail
  - getKeySize
```
public static int getKeySize()
```
    Returns:
    
    the KeySize
  - toBase32
```
public String toBase32()
```
    Returns:
    
    the Base32 representation (default of toString)
  - toBase64
```
public String toBase64()
```
    Returns:
    
    the Base64 representation (default of toString)
  - toHex
```
public String toHex()
```
    Returns:
    
    the Hexadecimal representation
  - toArk
```
public String toArk()
```
    Returns:
    
    the Ark representation of this GUID
  - getId
```
public String getId()
```
    Returns:
    
    the String representation of this GUID
  - getVersion
```
public final int getVersion()
```
    extract version field as a hex char from raw GUID bytes
    
    Returns:
    
    version char
  - getTenantId
```
public final int getTenantId()
```
    Returns:
    
    the Tenant Id of GUID from which it belongs to (default being 0)
  - getPlatformId
```
public final int getPlatformId()
```
    Extract Platform id as int. Could be using partial MAC address.
    
    Returns:
    
    the Platform id as int, or -1 for unrecognized format
  - getMacFragment
```
public final byte[] getMacFragment()
```
    Extract Platform id as bytes. Could be using partial MAC address.
    
    Returns:
    
    byte array of GUID fragment, or null for unrecognized format
  - getProcessId
```
public final int getProcessId()
```
    Extract process id and return as int
    
    Returns:
    
    id of process that generated the GUID, or -1 for unrecognized format
  - getTimestamp
```
public final long getTimestamp()
```
    Extract timestamp and return as long
    
    Returns:
    
    millisecond UTC timestamp from generation of the GUID, or -1 for unrecognized format
  - getCounter
```
public final int getCounter()
```
    Returns:
    
    the associated counter against collision value
  - toArkName
```
public final String toArkName()
```
    Returns:
    
    the Ark Name part of Ark representation
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBytes
```
public byte[] getBytes()
```
    copy the uuid of this GUID, so that it can't be changed, and return it
    
    Returns:
    
    raw byte array of GUID
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(GUID guid)
```
    Specified by:
    
    compareTo in interface Comparable<GUID>

Class GUID

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ARK

Constructor Detail

GUID

GUID

GUID

GUID

Method Detail

getKeySize

toBase32

toBase64

toHex

toArk

getId

getVersion

getTenantId

getPlatformId

getMacFragment

getProcessId

getTimestamp

getCounter

toArkName

toString

getBytes

hashCode

equals

compareTo