IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.core.message
Enum Message.Destination

java.lang.Object
  extended by java.lang.Enum<Message.Destination>
      extended by com.ibm.rational.test.lt.recorder.core.message.Message.Destination
All Implemented Interfaces:
Serializable, Comparable<Message.Destination>
Enclosing class:
Message

public static enum Message.Destination
extends Enum<Message.Destination>

Destination types that can receive messages.


Enum Constant Summary
CLIENTS
          The message will be delivered to clients.
LISTENERS
          The message will be delivered to the listeners of the sending component.
RECORDERS
          The message will be delivered to recorders.
SESSION
          The message will be delivered to the session.
 
Method Summary
static Message.Destination valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Message.Destination[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

RECORDERS

public static final Message.Destination RECORDERS
The message will be delivered to recorders. If a filter is specified, the filter must contains recorder ids, and the message will be delivered to those recorders of the specified type. If no filter is specified, the message will be delivered to all recorders of the same session.


CLIENTS

public static final Message.Destination CLIENTS
The message will be delivered to clients. If a filter is specified, the filter must contains client ids, and the message will be delivered to those clients of the specified type. If no filter is specified, the message will be delivered to all clients of the same session.


SESSION

public static final Message.Destination SESSION
The message will be delivered to the session. The filter argument is ignored.


LISTENERS

public static final Message.Destination LISTENERS
The message will be delivered to the listeners of the sending component. If a filter is specified, the filter must contain qualified class names of listeners, and the message will be delivered to only those listeners that are an instance of one of the specified classes.

Method Detail

values

public static Message.Destination[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (Message.Destination c : Message.Destination.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Message.Destination valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.