Package org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model

Class MethodDocType

  • public class MethodDocType
extends java.lang.Object
    The documentation type for methods.
    Created on: Jun 12, 2008

    • Field Detail

      • methodName

        private java.lang.String methodName

      • methodSignature

        protected java.lang.String methodSignature

      • commentText

        protected java.lang.String commentText

      • returnDoc

        private java.lang.String returnDoc

      • returnTypeExample

        private java.lang.String returnTypeExample

      • any

        private java.util.List<java.lang.Object> any

    • Constructor Detail

      • MethodDocType

        public MethodDocType()

    • Method Detail

      • getParamDocs

        public java.util.List<ParamDocType> getParamDocs()

      • getAny

        public java.util.List<java.lang.Object> getAny()

      • getMethodName

        public java.lang.String getMethodName()
        Get the method name.
        Returns:
        the method name.

      • setMethodName

        public void setMethodName​(java.lang.String methodName)
        Set the method name.
        Parameters:
        methodName - the method name to set.

      • getMethodSignature

        public java.lang.String getMethodSignature()
        Get the method signature, or null if no method signature has been set for the method.

        This string uniquely identifies the method in case there are multiple methods in the class with the same name.

        Returns:
        unique method signature within a class.
        Since:
        2.20

      • setMethodSignature

        public void setMethodSignature​(java.lang.String methodSignature)
        Set the unique method signature, including method parameters, if any.
        Parameters:
        methodSignature - method signature string to set.
        Since:
        2.20

      • getCommentText

        public java.lang.String getCommentText()
        Gets the value of the commentText property.
        Returns:
        the commentText

      • setCommentText

        public void setCommentText​(java.lang.String value)
        Sets the value of the commentText property.
        Parameters:
        value - the commentText

      • getReturnDoc

        public java.lang.String getReturnDoc()
        Returns:
        the returnDoc

      • setReturnDoc

        public void setReturnDoc​(java.lang.String returnDoc)
        Parameters:
        returnDoc - the returnDoc to set

      • getReturnTypeExample

        public java.lang.String getReturnTypeExample()
        Returns:
        the returnTypeExample

      • setReturnTypeExample

        public void setReturnTypeExample​(java.lang.String returnTypeExample)
        Parameters:
        returnTypeExample - the returnTypeExample to set

      • getRequestDoc

        public RequestDocType getRequestDoc()
        Returns:
        the requestDoc

      • setRequestDoc

        public void setRequestDoc​(RequestDocType requestDoc)
        Parameters:
        requestDoc - the requestDoc to set

      • getResponseDoc

        public ResponseDocType getResponseDoc()
        Returns:
        the responseDoc

      • setResponseDoc

        public void setResponseDoc​(ResponseDocType responseDoc)
        Parameters:
        responseDoc - the responseDoc to set