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

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

public class GenericGloballyUniqueCorrelator
extends GloballyUniqueCorrelator

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 class represents an opaque GUC and has a GUC type of 0. 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.


Field Summary
static java.lang.String genericGloballyUniqueCorrelatorCopyright
          Copyright statement.
 
Constructor Summary
GenericGloballyUniqueCorrelator()
          GenericGloballyUniqueCorrelator constructors
 
Method Summary
 byte[] getCorrelator()
          Gets the value of the correlator 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 setCorrelator(byte[] pd_Additional_Correlator_Info_correlator)
          Sets value of the correlator 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
 

Field Detail

genericGloballyUniqueCorrelatorCopyright

public static final java.lang.String genericGloballyUniqueCorrelatorCopyright
Copyright statement.

See Also:
Constant Field Values
Constructor Detail

GenericGloballyUniqueCorrelator

public GenericGloballyUniqueCorrelator()
GenericGloballyUniqueCorrelator constructors

Method Detail

getUniqueInstanceID

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

Overrides:
getUniqueInstanceID in class GloballyUniqueCorrelator
Returns:
The value of the uniqueInstanceID instance variable.

setCorrelator

public void setCorrelator(byte[] pd_Additional_Correlator_Info_correlator)
                   throws java.lang.IllegalArgumentException
Sets value of the correlator instance variable to the specified value.

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

getCorrelator

public byte[] getCorrelator()
Gets the value of the correlator instance variable.

Returns:
The value of the correlator instance variable, or null if the value of the correlator 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.

Overrides:
toCanonicalXMLString in class GloballyUniqueCorrelator
Returns:
the canonical XML representation of this object

regenerateUniqueInstanceID

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

Overrides:
regenerateUniqueInstanceID in class GloballyUniqueCorrelator

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.

Overrides:
init in class GloballyUniqueCorrelator