Package com.jprofiler.api.probe.injected
Interface Payload
-
public interface PayloadPayload type with enhanced functionality. To use this functionality, your probe method must return instances of this type instead ofString, declare a parameter with typeProbeContextto get a context instance and callProbeContext.createPayload(String, Object, Enum)to create a payload that it can return.Do not create your own subtypes.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.ObjectgetControlObject()The control object for this payload.java.lang.Enum<?>getEventType()The type of the payload.java.lang.StringgetName()The name for this payload.
-
-
-
Method Detail
-
getName
java.lang.String getName()
The name for this payload.- Returns:
- the name or
nullif none was provided yet
-
getEventType
java.lang.Enum<?> getEventType()
The type of the payload. One of the enum constants ofProbe.customTypes().- Returns:
- the type or
nullif none was provided
-
getControlObject
java.lang.Object getControlObject()
The control object for this payload.- Returns:
- the control object or
nullif none was provided
-
-