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