Package com.jprofiler.api.probe.injected
Interface Payload
public interface Payload
Payload type with enhanced functionality. To use this functionality, your probe method must return instances of this type instead of
String, declare a
parameter with type ProbeContext to get a context instance and call ProbeContext.createPayload(String, Object, Enum) to create a payload that it can return.
Do not create your own subtypes.
-
Method Details
-
getName
String getName()The name for this payload.- Returns:
- the name or
nullif none was provided yet
-
getEventType
Enum<?> getEventType()The type of the payload. One of the enum constants ofProbe.customTypes().- Returns:
- the type or
nullif none was provided
-
getControlObject
Object getControlObject()The control object for this payload.- Returns:
- the control object or
nullif none was provided
-