public class

ProcedureDescription

extends Object
java.lang.Object
   ↳ com.rabbitmq.tools.jsonrpc.ProcedureDescription

Class Overview

Description of a single JSON-RPC procedure.

Summary

Fields
public String help Human-readable instructions for how to get information on the procedure's operation
public boolean idempotent True if this procedure is idempotent, that is, can be accessed via HTTP GET
public String name Procedure name
public String summary Human-readable procedure summary
Public Constructors
ProcedureDescription(Map<StringObject> pm)
ProcedureDescription(Method m)
ProcedureDescription()
Public Methods
int arity()
Retrieves the parameter count for this procedure
ParameterDescription[] getParams()
String getReturn()
Getter for return type
Method internal_getMethod()
Private API - used to get the reflected method object, for servers
ParameterDescription[] internal_getParams()
Gets an array of parameter descriptions for all this procedure's parameters
void setReturn(String value)
Private API - used via reflection during parsing/loading
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public String help

Human-readable instructions for how to get information on the procedure's operation

public boolean idempotent

True if this procedure is idempotent, that is, can be accessed via HTTP GET

public String name

Procedure name

public String summary

Human-readable procedure summary

Public Constructors

public ProcedureDescription (Map<StringObject> pm)

public ProcedureDescription (Method m)

public ProcedureDescription ()

Public Methods

public int arity ()

Retrieves the parameter count for this procedure

public ParameterDescription[] getParams ()

public String getReturn ()

Getter for return type

public Method internal_getMethod ()

Private API - used to get the reflected method object, for servers

public ParameterDescription[] internal_getParams ()

Gets an array of parameter descriptions for all this procedure's parameters

public void setReturn (String value)

Private API - used via reflection during parsing/loading