Websphere MQ Everyplace

com.ibm.mqe.trace
Class MQeTracePointGroup

java.lang.Object
  |
  +--com.ibm.mqe.trace.MQeTracePointGroup

public class MQeTracePointGroup
extends java.lang.Object

This class holds information about a logical grouping of trace points.


Constructor Summary
MQeTracePointGroup(java.lang.String name, char abbreviation)
          Consturcts an MQeTracePointGroup object given the name and character code parameters.
MQeTracePointGroup(java.lang.String name, char abbreviation, MQeTracePoint[] tracePointArray)
          Consturcts an MQeTracePointGroup object given the name, character code parameters and an array of the tracepoints to be the member of this group.
 
Method Summary
 boolean addTracePoint(MQeTracePoint tracePoint)
          Adds a new trace point to this logical group of trace points.
 boolean contains(short msgNumber)
          Method which returns true if a trace point corresponding to the supplied msgNumber is present in the collection of trace points.
 long getBitMask()
          Gets a long value ( with a single bit set ) indicating the logical trace point group.
 java.lang.String getName()
          Gets a long name description of the logical trace point group.
 MQeTracePoint getTracePoint(short messageNumber)
          Returns a trace point from this logical group of trace points.
 MQeTracePoint[] getTracePoints()
          Gets a list of of trace points in this logical group.
 boolean removeTracePoint(short msgNumber)
          Removes a trace point from this logical group.
 void setAbbreviation(char newAbbreviation)
          Replaces the current abbreviation for a group with the passed character abbreviation.
 void setName(java.lang.String newName)
          Replaces the current long name for a group with the passed long name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MQeTracePointGroup

public MQeTracePointGroup(java.lang.String name,
                          char abbreviation)
                   throws java.lang.Exception
Consturcts an MQeTracePointGroup object given the name and character code parameters.

Parameters:
name - A String representing the group name.
abbreviation - Character code for the group.
Throws:
java.lang.Exception

MQeTracePointGroup

public MQeTracePointGroup(java.lang.String name,
                          char abbreviation,
                          MQeTracePoint[] tracePointArray)
Consturcts an MQeTracePointGroup object given the name, character code parameters and an array of the tracepoints to be the member of this group.

Parameters:
name - A String representing the group name.
abbreviation - Character code for the group.
tracePointArray - An array containg the tracepoints which are to be the member of this group.
Method Detail

getName

public java.lang.String getName()
Gets a long name description of the logical trace point group.

For example "Error", might be returned for the error group.

Returns:
the name of this group, or null if it has not been set.

setName

public void setName(java.lang.String newName)
Replaces the current long name for a group with the passed long name.

Parameters:
newName - A String containg the name of the new trace point group.
Returns:
void

getBitMask

public long getBitMask()
Gets a long value ( with a single bit set ) indicating the logical trace point group.

Returns:
A long value representing the logical trace point group.

setAbbreviation

public void setAbbreviation(char newAbbreviation)
Replaces the current abbreviation for a group with the passed character abbreviation.

Parameters:
newAbbreviation - The value to be set for abbreviation for a new group.

getTracePoint

public MQeTracePoint getTracePoint(short messageNumber)
Returns a trace point from this logical group of trace points.

Parameters:
messageNumber - A short value indicating the message number of the trace point.
Returns:
An MQeTracePoint object.

addTracePoint

public boolean addTracePoint(MQeTracePoint tracePoint)
Adds a new trace point to this logical group of trace points.

A trace point may be added to many trace point groups.

Parameters:
tracePoint - An MQeTracePoint to be added.
Returns:
True if addition operation is successful and False, otherwise.

removeTracePoint

public boolean removeTracePoint(short msgNumber)
Removes a trace point from this logical group. The trace point number is taken from the passed trace point. Any trace point with that number existing in this logical tracepoint group is removed.

Parameters:
msgNumber - A short value containing the message number which is to be removed.
Returns:
True if the removal operation is successful and False, otherwise.

getTracePoints

public MQeTracePoint[] getTracePoints()
Gets a list of of trace points in this logical group.

All trace points in this group are cloned, and a copy is added to the returned vector. If there are no tracepoints in this logical group, then a vector with no elements is returned.

Returns:
An array of MQeTracePoint objects.

contains

public boolean contains(short msgNumber)
Method which returns true if a trace point corresponding to the supplied msgNumber is present in the collection of trace points.

Parameters:
msgNumber - A short value contining the message number of trace points.
Returns:
True, if the message number is present in the collection of trace points and False, otherwise.

Websphere MQ Everyplace