Package springfox.documentation.spring.web

Class WebMvcRequestHandler

  • All Implemented Interfaces:
    java.lang.Comparable<springfox.documentation.RequestHandler>, springfox.documentation.RequestHandler
    public class WebMvcRequestHandler
extends java.lang.Object
implements springfox.documentation.RequestHandler

    • Constructor Summary

      Constructors 
      Constructor Description
      WebMvcRequestHandler​(java.lang.String contextPath, springfox.documentation.spring.web.readers.operation.HandlerMethodResolver methodResolver, org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMapping, org.springframework.web.method.HandlerMethod handlerMethod)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      springfox.documentation.RequestHandler combine​(springfox.documentation.RequestHandler other)  
      java.util.Set<org.springframework.http.MediaType> consumes()  
      java.lang.Class<?> declaringClass()  
      <T extends java.lang.annotation.Annotation>
      java.util.Optional<T>      		 findAnnotation​(java.lang.Class<T> annotation)  
      <T extends java.lang.annotation.Annotation>
      java.util.Optional<T>      		 findControllerAnnotation​(java.lang.Class<T> annotation)  
      org.springframework.web.method.HandlerMethod getHandlerMethod()  
      java.lang.String getName()  
      java.util.List<springfox.documentation.service.ResolvedMethodParameter> getParameters()  
      springfox.documentation.spring.wrapper.PatternsRequestCondition getPatternsCondition()  
      springfox.documentation.spring.wrapper.RequestMappingInfo<?> getRequestMapping()  
      com.fasterxml.classmate.ResolvedType getReturnType()  
      java.lang.String groupName()  
      java.util.Set<springfox.documentation.spring.wrapper.NameValueExpression<java.lang.String>> headers()  
      boolean isAnnotatedWith​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)  
      springfox.documentation.RequestHandlerKey key()  
      java.util.Set<springfox.documentation.spring.wrapper.NameValueExpression<java.lang.String>> params()  
      java.util.Set<org.springframework.http.MediaType> produces()  
      java.util.Set<org.springframework.web.bind.annotation.RequestMethod> supportedMethods()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface springfox.documentation.RequestHandler

        compareTo

    • Constructor Detail

      • WebMvcRequestHandler

        public WebMvcRequestHandler​(java.lang.String contextPath,
                            springfox.documentation.spring.web.readers.operation.HandlerMethodResolver methodResolver,
                            org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMapping,
                            org.springframework.web.method.HandlerMethod handlerMethod)

    • Method Detail

      • getHandlerMethod

        public org.springframework.web.method.HandlerMethod getHandlerMethod()
        Specified by:
        getHandlerMethod in interface springfox.documentation.RequestHandler

      • combine

        public springfox.documentation.RequestHandler combine​(springfox.documentation.RequestHandler other)
        Specified by:
        combine in interface springfox.documentation.RequestHandler

      • declaringClass

        public java.lang.Class<?> declaringClass()
        Specified by:
        declaringClass in interface springfox.documentation.RequestHandler

      • isAnnotatedWith

        public boolean isAnnotatedWith​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
        Specified by:
        isAnnotatedWith in interface springfox.documentation.RequestHandler

      • getPatternsCondition

        public springfox.documentation.spring.wrapper.PatternsRequestCondition getPatternsCondition()
        Specified by:
        getPatternsCondition in interface springfox.documentation.RequestHandler

      • groupName

        public java.lang.String groupName()
        Specified by:
        groupName in interface springfox.documentation.RequestHandler

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface springfox.documentation.RequestHandler

      • supportedMethods

        public java.util.Set<org.springframework.web.bind.annotation.RequestMethod> supportedMethods()
        Specified by:
        supportedMethods in interface springfox.documentation.RequestHandler

      • produces

        public java.util.Set<org.springframework.http.MediaType> produces()
        Specified by:
        produces in interface springfox.documentation.RequestHandler

      • consumes

        public java.util.Set<org.springframework.http.MediaType> consumes()
        Specified by:
        consumes in interface springfox.documentation.RequestHandler

      • headers

        public java.util.Set<springfox.documentation.spring.wrapper.NameValueExpression<java.lang.String>> headers()
        Specified by:
        headers in interface springfox.documentation.RequestHandler

      • params

        public java.util.Set<springfox.documentation.spring.wrapper.NameValueExpression<java.lang.String>> params()
        Specified by:
        params in interface springfox.documentation.RequestHandler

      • findAnnotation

        public <T extends java.lang.annotation.Annotation> java.util.Optional<T> findAnnotation​(java.lang.Class<T> annotation)
        Specified by:
        findAnnotation in interface springfox.documentation.RequestHandler

      • key

        public springfox.documentation.RequestHandlerKey key()
        Specified by:
        key in interface springfox.documentation.RequestHandler

      • getRequestMapping

        public springfox.documentation.spring.wrapper.RequestMappingInfo<?> getRequestMapping()
        Specified by:
        getRequestMapping in interface springfox.documentation.RequestHandler

      • getParameters

        public java.util.List<springfox.documentation.service.ResolvedMethodParameter> getParameters()
        Specified by:
        getParameters in interface springfox.documentation.RequestHandler

      • getReturnType

        public com.fasterxml.classmate.ResolvedType getReturnType()
        Specified by:
        getReturnType in interface springfox.documentation.RequestHandler

      • findControllerAnnotation

        public <T extends java.lang.annotation.Annotation> java.util.Optional<T> findControllerAnnotation​(java.lang.Class<T> annotation)
        Specified by:
        findControllerAnnotation in interface springfox.documentation.RequestHandler

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object