Modifier and Type	Class and Description
public static enum	EnhancedClassData.MethodType

Modifier and Type	Field and Description
public static final String	DESCRIPTION_NAME
public static final String	INFO_METHOD_NAME
public static final String	MM_NAME
public static final Type	MM_TYPE
public static final String	OBJECT_NAME
public static final Type	OBJECT_TYPE
public static final String	SH_NAME
public static final Type	SH_TYPE

Method Summary

Modifier and Type	Method and Description
public EnhancedClassData.MethodType	Returns: The kind of the corresponding method. classifyMethod(String The full method descriptor of the method. fullMethodDescriptor) Classify the method.
public Map<String, String>	Returns: Map from MM annotations defined on this class to the names of the holder fields. getAnnotationToHolderName() Map from MM annotation name to the name of the holder field that contains the SynchronizedHolder for the corresponding MethodMonitor.
public String	Returns: The class name. getClassName() Return the internal name of the class.
public List<String>	Returns: List of descriptions in the same order as in getMethodTracingNames. getDescriptions() List of descriptions of monitored methods and info methods.
public String	Returns: The name of the holder field used for this method. getHolderName(String The full method descriptor of the method. fullMethodDescriptor) Name of the holder fields corresponding to a particular method.
public int	Returns: the method index getMethodIndex(String The method name as defined for tracing. methodName) Index of method name in the list of method names.
public List<String>	Returns: List of annotation names for methods. getMethodMMAnnotationName() List of annotation names for each info method and monitored method.
public List<String>	Returns: List of all method tracing names in sorted order. getMethodNames() List of method names for all MM methods and info methods in the class.
public List<String>	Returns: List of timing point names, in the same order as in getMethodTracingNames. getTimingPointNames() List of timing point names corresponding to method names.
public List<TimingPointType>	Returns: List of TimingPointTypes in the same order as in getMethodTracingNames. getTimingPointTypes() List of timing point types of monitored methods and info methods.
public boolean	Returns: true iff this class has one or more MM annotations. isTracedClass() Returns true iff this class is monitored.
public void	updateInfoDesc() Enhance all of the descriptors for infoMethods.

Field Detail

DESCRIPTION_NAME	back to summary
public static final String DESCRIPTION_NAME

INFO_METHOD_NAME	back to summary
public static final String INFO_METHOD_NAME

MM_NAME	back to summary
public static final String MM_NAME

MM_TYPE	back to summary
public static final Type MM_TYPE

OBJECT_NAME	back to summary
public static final String OBJECT_NAME

OBJECT_TYPE	back to summary
public static final Type OBJECT_TYPE

SH_NAME	back to summary
public static final String SH_NAME

SH_TYPE	back to summary
public static final Type SH_TYPE

Method Detail

classifyMethod	back to summary
public EnhancedClassData.MethodType classifyMethod(String fullMethodDescriptor) Classify the method. Parameters fullMethodDescriptor:String The full method descriptor of the method. Returns:EnhancedClassData.MethodType The kind of the corresponding method.

classifyMethod

back to summary

public EnhancedClassData.MethodType classifyMethod(String fullMethodDescriptor)

Classify the method.

Parameters

fullMethodDescriptor:String: The full method descriptor of the method.

Returns:EnhancedClassData.MethodType

The kind of the corresponding method.

getAnnotationToHolderName	back to summary
public Map<String, String> getAnnotationToHolderName() Map from MM annotation name to the name of the holder field that contains the SynchronizedHolder for the corresponding MethodMonitor. The domain of this map is the set of MM annotations on this class. Returns:Map<String, String> Map from MM annotations defined on this class to the names of the holder fields.

getAnnotationToHolderName

back to summary

public Map<String, String> getAnnotationToHolderName()

Map from MM annotation name to the name of the holder field that contains the SynchronizedHolder for the corresponding MethodMonitor. The domain of this map is the set of MM annotations on this class.

Returns:Map<String, String>: Map from MM annotations defined on this class to the names of the holder fields.

getClassName	back to summary
public String getClassName() Return the internal name of the class. Returns:String The class name.

getClassName

back to summary

public String getClassName()

Return the internal name of the class.

Returns:String: The class name.

getDescriptions	back to summary
public List<String> getDescriptions() List of descriptions of monitored methods and info methods. If no description was given in the annotations, the value is "". Returns:List<String> List of descriptions in the same order as in getMethodTracingNames.

getDescriptions

back to summary

public List<String> getDescriptions()

List of descriptions of monitored methods and info methods. If no description was given in the annotations, the value is "".

Returns:List<String>: List of descriptions in the same order as in getMethodTracingNames.

getHolderName	back to summary
public String getHolderName(String fullMethodDescriptor) Name of the holder fields corresponding to a particular method. Note that the full descriptor (name + arg/return descriptor) is used to unambiguously identify the method in the class. Parameters fullMethodDescriptor:String The full method descriptor of the method. Returns:String The name of the holder field used for this method.

getHolderName

back to summary

public String getHolderName(String fullMethodDescriptor)

Name of the holder fields corresponding to a particular method. Note that the full descriptor (name + arg/return descriptor) is used to unambiguously identify the method in the class.

Parameters

fullMethodDescriptor:String: The full method descriptor of the method.

Returns:String

The name of the holder field used for this method.

getMethodIndex	back to summary
public int getMethodIndex(String methodName) Index of method name in the list of method names. Parameters methodName:String The method name as defined for tracing. Returns:int the method index

getMethodIndex

back to summary

public int getMethodIndex(String methodName)

Index of method name in the list of method names.

Parameters

methodName:String: The method name as defined for tracing.

Returns:int

the method index

getMethodMMAnnotationName	back to summary
public List<String> getMethodMMAnnotationName() List of annotation names for each info method and monitored method. It is interpreted as follows: If the entry in the list is not null, it is the only annotation applicable to this method. This is the case for monitored methods. If the entry in the list is null, all annotations on the enclosing class apply to this method. This is the case for an InfoMethod, which can be called from any monitored method regardless of the annotation on the monitored method. Returns:List<String> List of annotation names for methods.

getMethodMMAnnotationName

back to summary

public List<String> getMethodMMAnnotationName()

List of annotation names for each info method and monitored method. It is interpreted as follows:

If the entry in the list is not null, it is the only annotation applicable to this method. This is the case for monitored methods.
If the entry in the list is null, all annotations on the enclosing class apply to this method. This is the case for an InfoMethod, which can be called from any monitored method regardless of the annotation on the monitored method.

Returns:List<String>: List of annotation names for methods.

getMethodNames	back to summary
public List<String> getMethodNames() List of method names for all MM methods and info methods in the class. Order is significant, as the index of the method in the list is the ordinal used to represent it. This list is in sorted order. Returns:List<String> List of all method tracing names in sorted order.

getMethodNames

back to summary

public List<String> getMethodNames()

List of method names for all MM methods and info methods in the class. Order is significant, as the index of the method in the list is the ordinal used to represent it. This list is in sorted order.

Returns:List<String>: List of all method tracing names in sorted order.

getTimingPointNames	back to summary
public List<String> getTimingPointNames() List of timing point names corresponding to method names. For monitored methods, this is just the method name. For info methods whose tpType is not NONE, this is specified in tpName. Returns:List<String> List of timing point names, in the same order as in getMethodTracingNames.

getTimingPointNames

back to summary

public List<String> getTimingPointNames()

List of timing point names corresponding to method names. For monitored methods, this is just the method name. For info methods whose tpType is not NONE, this is specified in tpName.

Returns:List<String>: List of timing point names, in the same order as in getMethodTracingNames.

getTimingPointTypes	back to summary
public List<TimingPointType> getTimingPointTypes() List of timing point types of monitored methods and info methods. The list contains BOTH for a monitored method. An info method that does not represent a timing point is represented by NONE. Returns:List<TimingPointType> List of TimingPointTypes in the same order as in getMethodTracingNames.

getTimingPointTypes

back to summary

public List<TimingPointType> getTimingPointTypes()

List of timing point types of monitored methods and info methods. The list contains BOTH for a monitored method. An info method that does not represent a timing point is represented by NONE.

Returns:List<TimingPointType>: List of TimingPointTypes in the same order as in getMethodTracingNames.

isTracedClass	back to summary
public boolean isTracedClass() Returns true iff this class is monitored. Returns:boolean true iff this class has one or more MM annotations.

isTracedClass

back to summary

public boolean isTracedClass()

Returns true iff this class is monitored.

Returns:boolean: true iff this class has one or more MM annotations.

updateInfoDesc	back to summary
public void updateInfoDesc() Enhance all of the descriptors for infoMethods.

org.glassfish.pfl.tf.spi back to summary

public final Enum EnhancedClassData.MethodType

Class Inheritance

extends Enum<EnhancedClassData.MethodType>

java.lang.Object
java.lang.Enum
org.glassfish.pfl.tf.spi.EnhancedClassData.MethodType

Field Summary

Modifier and Type	Field and Description
public static final EnhancedClassData.MethodType	INFO_METHOD
public static final EnhancedClassData.MethodType	MONITORED_METHOD
public static final EnhancedClassData.MethodType	NORMAL_METHOD
public static final EnhancedClassData.MethodType	STATIC_INITIALIZER

Constructor Summary

Access	Constructor and Description
private	MethodType()

Method Summary

Modifier and Type	Method and Description
public static EnhancedClassData.MethodType	valueOf(String name)
public static EnhancedClassData.MethodType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

INFO_METHOD	back to summary
public static final EnhancedClassData.MethodType INFO_METHOD

MONITORED_METHOD	back to summary
public static final EnhancedClassData.MethodType MONITORED_METHOD

NORMAL_METHOD	back to summary
public static final EnhancedClassData.MethodType NORMAL_METHOD

STATIC_INITIALIZER	back to summary
public static final EnhancedClassData.MethodType STATIC_INITIALIZER

Constructor Detail

MethodType	back to summary
private MethodType()

Method Detail

valueOf	back to summary
public static EnhancedClassData.MethodType valueOf(String name)

values	back to summary
public static EnhancedClassData.MethodType[] values()

public Interface EnhancedClassData

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public final Enum EnhancedClassData.MethodType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail