Package org.restlet.ext.wadl

Class MethodInfo

  • @Deprecated
public class MethodInfo
extends DocumentedInfo
    Deprecated.
    Will be removed in next major release.
    Describes the expected requests and responses of a resource method.

    • Field Detail

      • identifier

        private java.lang.String identifier
        Deprecated.
        Identifier for the method.

      • name

        private Method name
        Deprecated.
        Name of the method.

      • request

        private RequestInfo request
        Deprecated.
        Describes the input to the method.

      • responses

        private java.util.List<ResponseInfo> responses
        Deprecated.
        Describes the output of the method.

      • targetRef

        private Reference targetRef
        Deprecated.
        Reference to a method definition element.

    • Constructor Detail

      • MethodInfo

        public MethodInfo()
        Deprecated.
        Constructor.

      • MethodInfo

        public MethodInfo​(DocumentationInfo documentation)
        Deprecated.
        Constructor with a single documentation element.
        Parameters:
        documentation - A single documentation element.

      • MethodInfo

        public MethodInfo​(java.util.List<DocumentationInfo> documentations)
        Deprecated.
        Constructor with a list of documentation elements.
        Parameters:
        documentations - The list of documentation elements.

      • MethodInfo

        public MethodInfo​(java.lang.String documentation)
        Deprecated.
        Constructor with a single documentation element.
        Parameters:
        documentation - A single documentation element.

    • Method Detail

      • describeAnnotations

        public static void describeAnnotations​(MethodInfo info,
                                       ServerResource resource)
        Deprecated.
        Automatically describe a method by discovering the resource's annotations.
        Parameters:
        info - The method description to update.
        resource - The server resource to describe.

      • getIdentifier

        public java.lang.String getIdentifier()
        Deprecated.
        Returns the identifier for the method.
        Returns:
        The identifier for the method.

      • getName

        public Method getName()
        Deprecated.
        Returns the name of the method.
        Returns:
        The name of the method.

      • getRequest

        public RequestInfo getRequest()
        Deprecated.
        Returns the input to the method.
        Returns:
        The input to the method.

      • getResponse

        public ResponseInfo getResponse()
        Deprecated.
        Returns the last added response of the method.
        Returns:
        The last added response of the method.

      • getResponses

        public java.util.List<ResponseInfo> getResponses()
        Deprecated.
        Returns the output of the method.
        Returns:
        The output of the method.

      • getTargetRef

        public Reference getTargetRef()
        Deprecated.
        Returns the reference to a method definition element.
        Returns:
        The reference to a method definition element.

      • setIdentifier

        public void setIdentifier​(java.lang.String identifier)
        Deprecated.
        Sets the identifier for the method.
        Parameters:
        identifier - The identifier for the method.

      • setName

        public void setName​(Method name)
        Deprecated.
        Sets the name of the method.
        Parameters:
        name - The name of the method.

      • setRequest

        public void setRequest​(RequestInfo request)
        Deprecated.
        Sets the input to the method.
        Parameters:
        request - The input to the method.

      • setResponses

        public void setResponses​(java.util.List<ResponseInfo> responses)
        Deprecated.
        Sets the output of the method.
        Parameters:
        responses - The output of the method.

      • setTargetRef

        public void setTargetRef​(Reference targetRef)
        Deprecated.
        Sets the reference to a method definition element.
        Parameters:
        targetRef - The reference to a method definition element.

      • updateNamespaces

        public void updateNamespaces​(java.util.Map<java.lang.String,​java.lang.String> namespaces)
        Deprecated.
        Description copied from class: DocumentedInfo
        Completes the given map of namespaces with the namespaces used in the documentation elements. The key is the URI of the namespace and the value, the prefix.
        Specified by:
        updateNamespaces in class DocumentedInfo
        Parameters:
        namespaces - The given map of namespaces to complete.

      • writeElement

        public void writeElement​(XmlWriter writer)
                  throws org.xml.sax.SAXException
        Deprecated.
        Writes the current object as an XML element using the given SAX writer.
        Parameters:
        writer - The SAX writer.
        Throws:
        org.xml.sax.SAXException