Package com.jprofiler.api.platform.descriptors

Interface PayloadDescriptor

All Superinterfaces:
Descriptor
public interface PayloadDescriptor extends Descriptor
Descriptor for a payload.

The description property of the super-interface contains the payload description, the type property of this derived interface contains the payload id.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getType()
    Returns the payload id.

    Methods inherited from interface com.jprofiler.api.platform.descriptors.Descriptor

    getDescription

  • Method Details

    • getType

      int getType()
      Returns the payload id. If the payload id is negative, it is one of the PAYLOAD_* constants in Payload, otherwise it is the payload of a registered custom probe.

      You can map the payload id of a probe to a description with ProbeInfo.getIdToDescription().

      Returns:
      the payload id