com.ibm.etools.logging.pd.artifacts
Class PD_GUID

java.lang.Object
  |
  +--com.ibm.etools.logging.pd.artifacts.PD_GUID

public class PD_GUID
extends java.lang.Object

Licensed Material - Property of IBM (C) Copyright IBM Corp. 2003, 2005 All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. This is the Globally Unique Identifier class. When reusing the object, users may re-initialize the object to a newly constructed state via the init() API. Otherwise, to reuse a partially initialized object, the uniqueInstanceID instance variable MUST be regenerated via the regenerateUniqueInstanceID() API.


Constructor Summary
PD_GUID()
          PD_GUID constructors
 
Method Summary
 byte[] getGuid_Data()
          Gets the value of the guid_Data instance variable.
 byte getGuid_Length()
          Gets the value of the guid_Length instance variable.
 byte getGuid_Type()
          Gets the value of the guid_Type instance variable.
 byte getGuid_Version()
          Gets the value of the guid_Version instance variable.
 java.lang.String getUniqueInstanceID()
          Gets the value of the uniqueInstanceID instance variable.
 void init()
          Initializes the object to a newly constructed state.
 void regenerateUniqueInstanceID()
          Regenerates a new unique instance ID for the object.
 void setGuid_Data(byte[] pd_GUID_guid_Data)
          Sets value of the guid_Data instance variable to the specified value.
 void setGuid_Length(byte pd_GUID_guid_Length)
          Sets value of the guid_Length instance variable to the specified value.
 void setGuid_Type(byte pd_GUID_guid_Type)
          Sets value of the guid_Type instance variable to the specified value.
 void setGuid_Version(byte pd_GUID_guid_Version)
          Sets value of the guid_Version instance variable to the specified value.
 java.lang.String toCanonicalXMLString()
          Creates the canonical XML representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PD_GUID

public PD_GUID()
PD_GUID constructors

Method Detail

getUniqueInstanceID

public java.lang.String getUniqueInstanceID()
Gets the value of the uniqueInstanceID instance variable.

Returns:
The value of the uniqueInstanceID instance variable.

setGuid_Length

public void setGuid_Length(byte pd_GUID_guid_Length)
Sets value of the guid_Length instance variable to the specified value.

Parameters:
pd_GUID_guid_Length - The new value of the guid_Length instance variable.

getGuid_Length

public byte getGuid_Length()
Gets the value of the guid_Length instance variable.

Returns:
The value of the guid_Length instance variable, or null if the value of the guid_Length instance variable has not been set or is set to null.

setGuid_Version

public void setGuid_Version(byte pd_GUID_guid_Version)
Sets value of the guid_Version instance variable to the specified value.

Parameters:
pd_GUID_guid_Version - The new value of the guid_Version instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter byte is not between 0 and 15.

getGuid_Version

public byte getGuid_Version()
Gets the value of the guid_Version instance variable.

Returns:
The value of the guid_Version instance variable, or null if the value of the guid_Version instance variable has not been set or is set to null.

setGuid_Type

public void setGuid_Type(byte pd_GUID_guid_Type)
Sets value of the guid_Type instance variable to the specified value.

Parameters:
pd_GUID_guid_Type - The new value of the guid_Type instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter byte is not between 0 and 15.

getGuid_Type

public byte getGuid_Type()
Gets the value of the guid_Type instance variable.

Returns:
The value of the guid_Type instance variable, or null if the value of the guid_Type instance variable has not been set or is set to null.

setGuid_Data

public void setGuid_Data(byte[] pd_GUID_guid_Data)
                  throws java.lang.IllegalArgumentException
Sets value of the guid_Data instance variable to the specified value.

Parameters:
pd_GUID_guid_Data - The new value of the guid_Data instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter array's length is greater than 32.

getGuid_Data

public byte[] getGuid_Data()
Gets the value of the guid_Data instance variable.

Returns:
The value of the guid_Data instance variable, or null if the value of the guid_Data instance variable has not been set or is set to null.

toCanonicalXMLString

public java.lang.String toCanonicalXMLString()
Creates the canonical XML representation of this object.

Returns:
the canonical XML representation of this object

regenerateUniqueInstanceID

public void regenerateUniqueInstanceID()
Regenerates a new unique instance ID for the object.


init

public void init()
Initializes the object to a newly constructed state. NOTE: To reuse the object without calling the init() API, the uniqueInstanceID instance variable MUST be regenerated via the regenerateUniqueInstanceID() API.