Package com.rabbitmq.tools.jsonrpc
Class ProcedureDescription
java.lang.Object
com.rabbitmq.tools.jsonrpc.ProcedureDescription
Description of a single JSON-RPC procedure.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Class
<?> private String
Human-readable instructions for how to get information on the procedure's operationprivate boolean
True if this procedure is idempotent, that is, can be accessed via HTTP GETprivate String
private Method
Reflected method object, used for service invocationprivate String
Procedure nameprivate ParameterDescription[]
Descriptions of parameters for this procedureprivate String
Return type for this procedureprivate String
Human-readable procedure summary -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionint
arity()
Retrieves the parameter count for this procedureprivate Class
<?> getHelp()
getName()
Getter for return typeClass
<?> Private API - used to get the reflected method object, for serversGets an array of parameter descriptions for all this procedure's parametersboolean
void
void
setIdempotent
(boolean idempotent) void
setJavaReturnType
(String javaReturnType) void
void
Private API - used via reflection during parsing/loadingvoid
setSummary
(String summary)
-
Field Details
-
name
Procedure name -
summary
Human-readable procedure summary -
help
Human-readable instructions for how to get information on the procedure's operation -
idempotent
private boolean idempotentTrue if this procedure is idempotent, that is, can be accessed via HTTP GET -
params
Descriptions of parameters for this procedure -
returnType
Return type for this procedure -
javaReturnType
-
_javaReturnTypeAsClass
-
method
Reflected method object, used for service invocation
-
-
Constructor Details
-
ProcedureDescription
-
ProcedureDescription
-
ProcedureDescription
public ProcedureDescription()
-
-
Method Details
-
getReturn
Getter for return type -
setReturn
Private API - used via reflection during parsing/loading -
internal_getMethod
Private API - used to get the reflected method object, for servers -
getJavaReturnType
-
setJavaReturnType
-
getReturnType
-
computeReturnTypeAsJavaClass
-
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
-
getName
-
getSummary
-
getHelp
-
isIdempotent
public boolean isIdempotent() -
setName
-
setSummary
-
setHelp
-
setIdempotent
public void setIdempotent(boolean idempotent)
-