decaf::util::UUID Class Reference

A class that represents an immutable universally unique identifier (UUID). More...

#include <src/main/decaf/util/UUID.h>

Inheritance diagram for decaf::util::UUID:

Public Member Functions
	UUID (long long mostSigBits, long long leastSigBits)
	Constructs a new UUID using the specified data.
	UUID (const UUID &source)
	Create a copy of the source UUID.
UUID &	operator= (const UUID &source)
	Copy the source UUID and return a reference to this UUID for chaining.
virtual	~UUID ()
virtual int	compareTo (const UUID &value) const
	Compare the given UUID to this one.
virtual bool	equals (const UUID &value) const
	Compares this UUID to the one given, returns true if they are equal.
int	hashCode () const
	Returns a Hash Code value for this UUID.
virtual bool	operator== (const UUID &value) const
	Compares equality between this object and the one passed.
virtual bool	operator< (const UUID &value) const
	Compares this object to another and returns true if this object is considered to be less than the one passed.
std::string	toString () const
	Returns a String object representing this UUID.
long long	getLeastSignificantBits () const
long long	getMostSignificantBits () const
long long	node ()
	The node value associated with this UUID.
long long	timestamp ()
	The timestamp value associated with this UUID.
int	clockSequence ()
	The clock sequence value associated with this UUID.
int	variant ()
	The variant number associated with this UUID.
int	version ()
	The version number associated with this UUID.
Static Public Member Functions
static UUID	randomUUID ()
	Static factory to retrieve a type 4 (pseudo randomly generated) UUID.
static UUID	nameUUIDFromBytes (const std::vector< char > &name)
	Static factory to retrieve a type 3 (name based) UUID based on the specified byte array.
static UUID	nameUUIDFromBytes (const char *name, int size)
	Static factory to retrieve a type 3 (name based) UUID based on the specified byte array.
static UUID	fromString (const std::string &name)
	Creates a UUID from the string standard representation as described in the toString() method.

Detailed Description

A class that represents an immutable universally unique identifier (UUID).

A UUID represents a 128-bit value.

There exist different variants of these global identifiers. The methods of this class are for manipulating the Leach-Salz variant, although the constructors allow the creation of any variant of UUID (described below).

The layout of a variant 2 (Leach-Salz) UUID is as follows: The most significant long consists of the following unsigned fields:

0xFFFFFFFF00000000 time_low 0x00000000FFFF0000 time_mid 0x000000000000F000 version 0x0000000000000FFF time_hi

The least significant long consists of the following unsigned fields:

0xC000000000000000 variant 0x3FFF000000000000 clock_seq 0x0000FFFFFFFFFFFF node

The variant field contains a value which identifies the layout of the UUID. The bit layout described above is valid only for a UUID with a variant value of 2, which indicates the Leach-Salz variant.

The version field holds a value that describes the type of this UUID. There are four different basic types of UUIDs: time-based, DCE security, name-based, and randomly generated UUIDs. These types have a version value of 1, 2, 3 and 4, respectively.

For more information including algorithms used to create UUIDs, see the Internet-Draft UUIDs and GUIDs or the standards body definition at ISO/IEC 11578:1996.

Constructor & Destructor Documentation

decaf::util::UUID::UUID	(	long long	mostSigBits,
		long long	leastSigBits
	)

Constructs a new UUID using the specified data.

mostSigBits is used for the most significant 64 bits of the UUID and leastSigBits becomes the least significant 64 bits of the UUID.

Parameters:

	mostSigBits
	leastSigBits

decaf::util::UUID::UUID ( const UUID & source )

Create a copy of the source UUID.

Parameters:

source

The UUID whose value initializes this UUID

virtual decaf::util::UUID::~UUID ( ) [virtual]

Member Function Documentation

int decaf::util::UUID::clockSequence ( )

The clock sequence value associated with this UUID.

The 14 bit clock sequence value is constructed from the clock sequence field of this UUID. The clock sequence field is used to guarantee temporal uniqueness in a time-based UUID.

The clockSequence value is only meaningful in a time-based UUID, which has version type 1. If this UUID is not a time-based UUID then this method throws UnsupportedOperationException.

Returns:: the clockSequeunce associated with a V1 UUID

Exceptions:

UnsupportedOperationException

if this UUID version does not support this operation.

virtual int decaf::util::UUID::compareTo ( const UUID & value ) const [virtual]

Compare the given UUID to this one.

Parameters:

value

- the UUID to compare to

virtual bool decaf::util::UUID::equals ( const UUID & value ) const [virtual]

Compares this UUID to the one given, returns true if they are equal.

Parameters:

value

The UUID to compare to.

Returns:: true if UUIDs are the same.

static UUID decaf::util::UUID::fromString ( const std::string & name ) [static]

Creates a UUID from the string standard representation as described in the toString() method.

Parameters:

name

A string to be used to construct a UUID.

Returns:: type 3 UUID

Exceptions:

IllegalArgumentException

if the UUID string given is invalid.

long long decaf::util::UUID::getLeastSignificantBits ( ) const

Returns:: the most significant 64 bits of this UUID's 128 bit value.

long long decaf::util::UUID::getMostSignificantBits ( ) const

Returns:: the most significant 64 bits of this UUID's 128 bit value.

int decaf::util::UUID::hashCode ( ) const

Returns a Hash Code value for this UUID.

Returns:: a Hash Code for this UUID

static UUID decaf::util::UUID::nameUUIDFromBytes	(	const char *	name,
		int	size
	)			`[static]`

Static factory to retrieve a type 3 (name based) UUID based on the specified byte array.

Parameters:

	name	A byte array to be used to construct a UUID.
	size	The size of the byte array, or number of bytes to use.

Returns:: type 3 UUID

static UUID decaf::util::UUID::nameUUIDFromBytes ( const std::vector< char > & name ) [static]

Static factory to retrieve a type 3 (name based) UUID based on the specified byte array.

Parameters:

name

A byte array to be used to construct a UUID.

Returns:: type 3 UUID

long long decaf::util::UUID::node ( )

The node value associated with this UUID.

The 48 bit node value is constructed from the node field of this UUID. This field is intended to hold the IEEE 802 address of the machine that generated this UUID to guarantee spatial uniqueness.

The node value is only meaningful in a time-based UUID, which has version type 1. If this UUID is not a time-based UUID then this method throws UnsupportedOperationException.

Returns:: the node value of this UUID

Exceptions:

UnsupportedOperationException

if this UUID version does not support this operation.

virtual bool decaf::util::UUID::operator< ( const UUID & value ) const [virtual]

Compares this object to another and returns true if this object is considered to be less than the one passed.

This

Parameters:

value

- the value to be compared to this one.

Returns:: true if this object is equal to the one passed.

UUID& decaf::util::UUID::operator= ( const UUID & source )

Copy the source UUID and return a reference to this UUID for chaining.

Parameters:

source

The UUID whose value replaces the current values in this UUID

Returns:: a reference to this UUID

virtual bool decaf::util::UUID::operator== ( const UUID & value ) const [virtual]

Compares equality between this object and the one passed.

Parameters:

value

- the value to be compared to this one.

Returns:: true if this object is equal to the one passed.

static UUID decaf::util::UUID::randomUUID ( ) [static]

Static factory to retrieve a type 4 (pseudo randomly generated) UUID.

The UUID is generated using a cryptographically strong pseudo random number generator.

Returns:: type 4 UUID

long long decaf::util::UUID::timestamp ( )

The timestamp value associated with this UUID.

The 60 bit timestamp value is constructed from the time_low, time_mid, and time_hi fields of this UUID. The resulting timestamp is measured in 100-nanosecond units since midnight, October 15, 1582 UTC.

The timestamp value is only meaningful in a time-based UUID, which has version type 1. If this UUID is not a time-based UUID then this method throws UnsupportedOperationException.

Returns:: the timestamp associated with a V1 UUID

Exceptions:

UnsupportedOperationException

if this UUID version does not support this operation.

std::string decaf::util::UUID::toString ( ) const

Returns a String object representing this UUID.

The UUID string representation is as described by this BNF :

UUID = <time_low> "-" <time_mid> "-" <time_high_and_version> "-" <variant_and_sequence> "-" <node> time_low = 4*<hexOctet> time_mid = 2*<hexOctet> time_high_and_version = 2*<hexOctet> variant_and_sequence = 2*<hexOctet> node = 6*<hexOctet> hexOctet = <hexDigit><hexDigit> hexDigit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "A" | "B" | "C" | "D" | "E" | "F"

Returns:: formatted string for this UUID

int decaf::util::UUID::variant ( )

The variant number associated with this UUID.

The variant number describes the layout of the UUID. The variant number has the following meaning:

* 0 Reserved for NCS backward compatibility * 2 The Leach-Salz variant (used by this class) * 6 Reserved, Microsoft Corporation backward compatibility * 7 Reserved for future definition

Returns:: the variant associated with a V1 UUID

Exceptions:

UnsupportedOperationException

if this UUID version does not support this operation.

int decaf::util::UUID::version ( )

The version number associated with this UUID.

The version number describes how this UUID was generated. The version number has the following meaning:

* 1 Time-based UUID * 2 DCE security UUID * 3 Name-based UUID * 4 Randomly generated UUID

Returns:: the version associated with a V1 UUID

Exceptions:

UnsupportedOperationException

if this UUID version does not support this operation.

The documentation for this class was generated from the following file:

src/main/decaf/util/UUID.h

decaf::util::UUID Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation