com.jprofiler.api.platform.descriptors
Interface Descriptor

All Known Subinterfaces:

ArrayDescriptor, ClassDescriptor, MethodDescriptor, PackageDescriptor, PayloadDescriptor, URLDescriptor

public interface Descriptor

A descriptor describes the contents of a profiling value or a heap value.

This is a common super-interface, the platform always returns derived interfaces as descriptors. Unless it is clear what the actual interface is, you have to find out the actual type with instanceof comparisons before down-casting a descriptor.

Besides the common description text, derived interfaces can expose more information about the profiling value. The semantics of the description property is documented in the derived interfaces.

See Also:

ProfilingValue, HeapValue

Method Summary

java.lang.String

getDescription() Returns the description.

Method Detail

getDescription

java.lang.String getDescription()

Returns the description. The contents of the returned string are documented in the derived interfaces.

Returns:

the description