com.oracle.truffle.tools.dap.types

Class Response

java.lang.Object

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

com.oracle.truffle.tools.dap.types.ProtocolMessage

com.oracle.truffle.tools.dap.types.Response

Direct Known Subclasses:

AttachResponse, BreakpointLocationsResponse, CancelResponse, CompletionsResponse, ConfigurationDoneResponse, ContinueResponse, DataBreakpointInfoResponse, DisassembleResponse, DisconnectResponse, ErrorResponse, EvaluateResponse, ExceptionInfoResponse, GotoResponse, GotoTargetsResponse, InitializeResponse, LaunchResponse, LoadedSourcesResponse, ModulesResponse, NextResponse, PauseResponse, ReadMemoryResponse, RestartFrameResponse, RestartResponse, ReverseContinueResponse, RunInTerminalResponse, ScopesResponse, SetBreakpointsResponse, SetDataBreakpointsResponse, SetExceptionBreakpointsResponse, SetExpressionResponse, SetFunctionBreakpointsResponse, SetVariableResponse, SourceResponse, StackTraceResponse, StepBackResponse, StepInResponse, StepInTargetsResponse, StepOutResponse, TerminateResponse, TerminateThreadsResponse, ThreadsResponse, VariablesResponse

public class Response
extends ProtocolMessage

Response for a request.

Method Summary

Modifier and Type	Method and Description
static Response	create(Integer requestSeq, Boolean success, String command, Integer seq)
boolean	equals(Object obj)
Object	getBody() Contains request result if success is true and optional error details if success is false.
String	getCommand() The command requested.
String	getMessage() Contains the raw error in short form if 'success' is false.
int	getRequestSeq() Sequence number of the corresponding request.
int	hashCode()
boolean	isSuccess() Outcome of the request.
Response	setBody(Object body)
Response	setCommand(String command)
Response	setMessage(String message)
Response	setRequestSeq(int requestSeq)
Response	setSuccess(boolean success)

Methods inherited from class com.oracle.truffle.tools.dap.types.ProtocolMessage

create, getSeq, getType, setSeq, setType

Methods inherited from class java.lang.Object

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

Method Detail

getRequestSeq

public int getRequestSeq()

Sequence number of the corresponding request.

setRequestSeq

public Response setRequestSeq(int requestSeq)

isSuccess

public boolean isSuccess()

Outcome of the request. If true, the request was successful and the 'body' attribute may contain the result of the request. If the value is false, the attribute 'message' contains the error in short form and the 'body' may contain additional information (see 'ErrorResponse.body.error').

setSuccess

public Response setSuccess(boolean success)

getCommand

public String getCommand()

The command requested.

setCommand

public Response setCommand(String command)

getMessage

public String getMessage()

Contains the raw error in short form if 'success' is false. This raw error might be interpreted by the frontend and is not shown in the UI. Some predefined values exist. Values: 'cancelled': request was cancelled. etc.

setMessage

public Response setMessage(String message)

getBody

public Object getBody()

Contains request result if success is true and optional error details if success is false.

setBody

public Response setBody(Object body)

equals

public boolean equals(Object obj)

Overrides:

equals in class ProtocolMessage

hashCode

public int hashCode()

Overrides:

hashCode in class ProtocolMessage

create

public static Response create(Integer requestSeq,
                              Boolean success,
                              String command,
                              Integer seq)