IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.core.extensibility
Interface IPacketExtensionRegistry


public interface IPacketExtensionRegistry

Provides information about registered recorder packet types and annotation types.


Method Summary
 Set<String> getAllSubTypes(String type)
          Returns all types that extend the specified packet type.
 String getAnnotationTypeName(String annotationType)
          Returns a user-facing string that describes the annotation type.
 Set<String> getAnnotationTypes()
          Returns all the annotation types registered on the platform.
 org.osgi.framework.Bundle getDeclaringBundle(String packetType)
          Returns the bundle that declares a packet type.
 Set<String> getDirectSubTypes(String type)
          Returns all types that directly extend the specified packet type.
 String getPacketTypeName(String packetType)
          Returns a user-facing string that describes the packet type.
 Set<String> getPacketTypes()
          Returns all the packet types registered on the platform.
 String getSuperType(String packetType)
          Returns the packet type that a given packet type extends, if any.
 boolean isExtending(String subType, String superType)
          Returns whether a given packet type extends, directly or indirectly, another packet type.
 String resolvePacketAlias(String packetType)
          If a packet type was renamed, returns the new ID of the packet type corresponding to the legacy ID.
 

Method Detail

getDeclaringBundle

org.osgi.framework.Bundle getDeclaringBundle(String packetType)
Returns the bundle that declares a packet type. The bundle is required to load any implementation class of this packet type.

Parameters:
packetType - A recorder packet type.
Returns:
The bundle that declares the packet type, or null if the packet type is unknown.

getPacketTypeName

String getPacketTypeName(String packetType)
Returns a user-facing string that describes the packet type.

Parameters:
packetType - A recorder packet type.
Returns:
A user-facing string that describes the packet type. A placeholder string such as "Unknown packet (xxx.yyy)" will be returned if the packet type is unknown.

getSuperType

String getSuperType(String packetType)
Returns the packet type that a given packet type extends, if any.

Parameters:
packetType - A recorder packet type.
Returns:
The super type, or null if the packet type does not extend any type.

isExtending

boolean isExtending(String subType,
                    String superType)
Returns whether a given packet type extends, directly or indirectly, another packet type.

Parameters:
subType - A recorder packet type.
superType - A recorder packet type.
Returns:
Whether subType is or extends superType.

getAnnotationTypeName

String getAnnotationTypeName(String annotationType)
Returns a user-facing string that describes the annotation type.

Parameters:
packetType - A recorder annotation type.
Returns:
A user-facing string that describes the annotation type. A placeholder string such as "Unknown annotation (xxx.yyy)" will be returned if the annotation type is unknown.

getPacketTypes

Set<String> getPacketTypes()
Returns all the packet types registered on the platform.

Returns:
All the packet types registered on the platform.

getDirectSubTypes

Set<String> getDirectSubTypes(String type)
Returns all types that directly extend the specified packet type. This does not include the type passed as an argument.

Parameters:
type -
Returns:

getAllSubTypes

Set<String> getAllSubTypes(String type)
Returns all types that extend the specified packet type. This includes the type passed as an argument, so the returned set is never empty, except if the specified type is not declared.

Parameters:
type -
Returns:

resolvePacketAlias

String resolvePacketAlias(String packetType)
If a packet type was renamed, returns the new ID of the packet type corresponding to the legacy ID.

Parameters:
packetType - A legacy ID.
Returns:
The new ID, or the same ID if this ID is still the most current one.

getAnnotationTypes

Set<String> getAnnotationTypes()
Returns all the annotation types registered on the platform.

Returns:
All the annotation types registered on the platform.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.