ProcedureDescription

java.lang.Object

com.rabbitmq.tools.jsonrpc.ProcedureDescription

public class ProcedureDescription extends Object

Description of a single JSON-RPC procedure.

Field Summary

Fields

Modifier and Type

Field

Description

String

help

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

boolean

idempotent

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

String

name

Procedure name

String

summary

Human-readable procedure summary
Constructor Summary

Constructors

Constructor

Description

ProcedureDescription()

ProcedureDescription(Method m)

ProcedureDescription(Map<String,Object> pm)
Method Summary

Modifier and Type

Method

Description

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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