com.oracle.truffle.tools.dap.types

Class ProgressStartEvent.EventBody

java.lang.Object

com.oracle.truffle.tools.dap.types.JSONBase

com.oracle.truffle.tools.dap.types.ProgressStartEvent.EventBody

Enclosing class:

ProgressStartEvent

public static class ProgressStartEvent.EventBody
extends JSONBase

Method Summary

Modifier and Type	Method and Description
static ProgressStartEvent.EventBody	create(String progressId, String title)
boolean	equals(Object obj)
Boolean	getCancellable() If true, the request that reports progress may be canceled with a 'cancel' request.
String	getMessage() Optional, more detailed progress message.
Integer	getPercentage() Optional progress percentage to display (value range: 0 to 100).
String	getProgressId() An ID that must be used in subsequent 'progressUpdate' and 'progressEnd' events to make them refer to the same progress reporting.
Integer	getRequestId() The request ID that this progress report is related to.
String	getTitle() Mandatory (short) title of the progress reporting.
int	hashCode()
ProgressStartEvent.EventBody	setCancellable(Boolean cancellable)
ProgressStartEvent.EventBody	setMessage(String message)
ProgressStartEvent.EventBody	setPercentage(Integer percentage)
ProgressStartEvent.EventBody	setProgressId(String progressId)
ProgressStartEvent.EventBody	setRequestId(Integer requestId)
ProgressStartEvent.EventBody	setTitle(String title)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getProgressId

public String getProgressId()

An ID that must be used in subsequent 'progressUpdate' and 'progressEnd' events to make them refer to the same progress reporting. IDs must be unique within a debug session.

setProgressId

public ProgressStartEvent.EventBody setProgressId(String progressId)

getTitle

public String getTitle()

Mandatory (short) title of the progress reporting. Shown in the UI to describe the long running operation.

setTitle

public ProgressStartEvent.EventBody setTitle(String title)

getRequestId

public Integer getRequestId()

The request ID that this progress report is related to. If specified a debug adapter is expected to emit progress events for the long running request until the request has been either completed or cancelled. If the request ID is omitted, the progress report is assumed to be related to some general activity of the debug adapter.

setRequestId

public ProgressStartEvent.EventBody setRequestId(Integer requestId)

getCancellable

public Boolean getCancellable()

If true, the request that reports progress may be canceled with a 'cancel' request. So this property basically controls whether the client should use UX that supports cancellation. Clients that don't support cancellation are allowed to ignore the setting.

setCancellable

public ProgressStartEvent.EventBody setCancellable(Boolean cancellable)

getMessage

public String getMessage()

Optional, more detailed progress message.

setMessage

public ProgressStartEvent.EventBody setMessage(String message)

getPercentage

public Integer getPercentage()

Optional progress percentage to display (value range: 0 to 100). If omitted no percentage will be shown.

setPercentage

public ProgressStartEvent.EventBody setPercentage(Integer percentage)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

create

public static ProgressStartEvent.EventBody create(String progressId,
                                                  String title)