de.aristaflow.adept2.util

Class UUIDTools

java.lang.Object

de.aristaflow.adept2.util.UUIDTools

public final class UUIDTools
extends java.lang.Object

Tool class for creating and managing UUIDs. Always use this class when in need of a UUID.

Author:

Ulrich Kreher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UUIDTools.UUIDComparator A UUID comparator comparing UUIDs unsigned, that is a leading 7 is less than a leading 8.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORBIDDEN_LONG The constant value that must not occur as part of a created UUID.
static java.util.UUID	NON_EXISTING_UUID The UUID that will never exist, created with the FORBIDDEN_LONG as most and least sig bits.

Method Summary

Modifier and Type	Method and Description
static java.util.UUID	createNegativeRandomUUID() Creates a random UUID which has a negative sign, that means a special bit for distinguishing two complementary cases.
static java.util.UUID	createNegativeRandomUUIDDebug() Creates a consecutive UUID having a negative sign.
static java.util.UUID	createPositiveUUID() Creates a random UUID which has a positive sign, that means a special bit for distinguishing two complementary cases.
static java.util.UUID	createPositiveUUIDDebug() Creates a consecutive UUID having a positive sign.
static java.util.UUID	createRandomUUID() Creates a simple random UUID with no part of it being FORBIDDEN_LONG.
static java.util.UUID	createRandomUUIDDebug() Creates a consecutive UUID.
static SerialisableComparator<java.util.UUID>	getUnsignedComparator() Gets a new UUID comparator comparing UUIDs unsigned, that is a leading 7 is less than a leading 8.
static boolean	isNegative(java.util.UUID uuid) Returns whether the designated UUID is "negative", that is, it has a negative sign (the most significant bits are a negative long value).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORBIDDEN_LONG

public static final int FORBIDDEN_LONG

The constant value that must not occur as part of a created UUID.

See Also:

Constant Field Values

NON_EXISTING_UUID

public static final java.util.UUID NON_EXISTING_UUID

The UUID that will never exist, created with the FORBIDDEN_LONG as most and least sig bits.

Method Detail

createRandomUUID

public static java.util.UUID createRandomUUID()

Creates a simple random UUID with no part of it being FORBIDDEN_LONG.

Returns:

A simple random UUID with no part of it being FORBIDDEN_LONG.

See Also:

UUID.randomUUID()

createRandomUUIDDebug

public static java.util.UUID createRandomUUIDDebug()

Creates a consecutive UUID. This is useful for debugging purpose when using instead of a random UUID. The sequence will be reset when loading this class.

Returns:

A consecutive UUID for debugging random UUIDs.

See Also:

createRandomUUID()

createPositiveUUID

public static java.util.UUID createPositiveUUID()

Creates a random UUID which has a positive sign, that means a special bit for distinguishing two complementary cases. For instance, this can be used for unmodified instances while a modified instance can have a negative UUID.

Returns:

A random "positive" UUID.

createPositiveUUIDDebug

public static java.util.UUID createPositiveUUIDDebug()

Creates a consecutive UUID having a positive sign. This is useful for debugging purpose when using instead of a random positive UUID.

Returns:

A consecutive "positive" UUID.

See Also:

createPositiveUUID()

createNegativeRandomUUID

public static java.util.UUID createNegativeRandomUUID()

Creates a random UUID which has a negative sign, that means a special bit for distinguishing two complementary cases. For instance, this can be used for modified instances while an unmodified instance can have a positive UUID.

Returns:

A random "negative" UUID.

createNegativeRandomUUIDDebug

public static java.util.UUID createNegativeRandomUUIDDebug()

Creates a consecutive UUID having a negative sign. This is useful for debugging purpose when using instead of a random negative UUID.

Returns:

A consecutive "negative" UUID.

See Also:

createNegativeRandomUUID()

isNegative

public static boolean isNegative(java.util.UUID uuid)

Returns whether the designated UUID is "negative", that is, it has a negative sign (the most significant bits are a negative long value).

Parameters:

uuid - The UUID to check whether it is negative.

Returns:

Whether the designated UUID is "negative" (the most significant bits are a negative long value).

getUnsignedComparator

public static SerialisableComparator<java.util.UUID> getUnsignedComparator()

Gets a new UUID comparator comparing UUIDs unsigned, that is a leading 7 is less than a leading 8. Signed it would be vice versa since 8 is negative.

Returns:

A new UUID comparator comparing UUIDs unsigned