net.freeutils.tnef

Class GUID

java.lang.Object

net.freeutils.tnef.GUID

public class GUID
extends java.lang.Object

The GUID class encapsulates a GUID (Globally Unique IDentifier). GUID instances are immutable.

Since:

2007-07-19

Author:

Amichai Rothman

Constructor Summary

Constructors

Constructor and Description
GUID(byte[] guid) Constructs a GUID with the specified value.
GUID(java.lang.String guid) Constructs a GUID with the specified value.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	canonize(java.lang.String guid) Canonizes the given GUID string into the canonical format of the form: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", with all values presented as lowercase hex digits.
boolean	equals(java.lang.Object o) Returns whether this GUID is identical to the given GUID.
int	hashCode() Returns a hash code value for the object.
byte[]	toByteArray() Returns the GUID as a 16-byte array.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GUID

public GUID(java.lang.String guid)

Constructs a GUID with the specified value.

Parameters:

guid - the GUID value as a hex string (with optional canonical dashes)

Throws:

java.lang.IllegalArgumentException - if the given string does not contain a valid GUID

GUID

public GUID(byte[] guid)

Constructs a GUID with the specified value.

Parameters:

guid - the GUID value

Throws:

java.lang.IllegalArgumentException - if the given array does not contain a valid GUID

Method Detail

canonize

public static java.lang.String canonize(java.lang.String guid)

Canonizes the given GUID string into the canonical format of the form: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", with all values presented as lowercase hex digits. Valid GUIDs consist of 32 case insensitive hex digits (representing 16 bytes), with or without the separating dashes in the appropriate positions.

Parameters:

guid - the GUID value

Returns:

the canonized GUID string

Throws:

java.lang.IllegalArgumentException - if the given string does not contain a valid GUID

toByteArray

public byte[] toByteArray()

Returns the GUID as a 16-byte array.

Returns:

the GUID as a 16-byte array

toString

public java.lang.String toString()

Returns a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this object

equals

public boolean equals(java.lang.Object o)

Returns whether this GUID is identical to the given GUID.

Overrides:

equals in class java.lang.Object

Returns:

true if this object is the same as the obj argument; false otherwise

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object