Class ProcedureDescription


  • public class ProcedureDescription
    extends java.lang.Object
    Description of a single JSON-RPC procedure.
    • 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
      • 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
    • Constructor Detail

      • ProcedureDescription

        public ProcedureDescription​(java.util.Map<java.lang.String,​java.lang.Object> pm)
      • ProcedureDescription

        public ProcedureDescription​(java.lang.reflect.Method m)
      • ProcedureDescription

        public ProcedureDescription()
    • 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
      • 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)