INT-2964 Various JavaDoc Fixes
INT-2964 - JavaDoc: <emphasis> should be <em>
INT-2964 - JavaDoc: <p/> should be <p>
INT-2964 - JavaDoc polishing
* <li></li> should be wrapped in <ul></ul>
* wrap code snippets in {@code myCode()}
* change <code>false</false> to <code>false</code>
INT-2964 - Polish - Fix more JavaDoc errors
* Mockito-all dependency causes JavaDoc error. Change dependency to Mockito-Core.
This commit is contained in:
committed by
Gary Russell
parent
4c348d3785
commit
05062aa0b2
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2002-2012 the original author or authors.
|
||||
* Copyright 2002-2013 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -40,9 +40,9 @@ import org.springframework.web.servlet.mvc.Controller;
|
||||
/**
|
||||
* Inbound HTTP endpoint that implements Spring's {@link Controller} interface to be used with a DispatcherServlet front
|
||||
* controller.
|
||||
* <p/>
|
||||
* <p>
|
||||
* The {@link #setViewName(String) viewName} will be passed into the ModelAndView return value.
|
||||
* <p/>
|
||||
* <p>
|
||||
* This endpoint will have request/reply behavior by default. That can be overridden by passing <code>false</code> to
|
||||
* the constructor. In the request/reply case, the core map will be passed to the view, and it will contain either the
|
||||
* reply Message or payload depending on the value of {@link #extractReplyPayload} (true by default, meaning just the
|
||||
|
||||
@@ -73,20 +73,21 @@ import org.springframework.web.util.UrlPathHelper;
|
||||
|
||||
/**
|
||||
* Base class for HTTP request handling endpoints.
|
||||
* <p/>
|
||||
* <p>
|
||||
* By default GET and POST requests are accepted, but the 'supportedMethods' property may be set to include others or
|
||||
* limit the options (e.g. POST only). A GET request will generate a payload containing its 'parameterMap' while a POST
|
||||
* request will be converted to a Message payload according to the registered {@link HttpMessageConverter}s. Several are
|
||||
* registered by default, but the list can be explicitly set via {@link #setMessageConverters(List)}.
|
||||
* <p/>
|
||||
* To customize the mapping of request headers to the MessageHeaders, provide a reference to a {@link HeaderMapper
|
||||
* HeaderMapper<HttpHeaders>} implementation to the {@link #setHeaderMapper(HeaderMapper)} method.
|
||||
* <p/>
|
||||
* <p>
|
||||
* To customize the mapping of request headers to the MessageHeaders, provide a
|
||||
* reference to a {@code HeaderMapper<HttpHeaders>} implementation
|
||||
* to the {@link #setHeaderMapper(HeaderMapper)} method.
|
||||
* <p>
|
||||
* The behavior is "request/reply" by default. Pass <code>false</code> to the constructor to force send-only as opposed
|
||||
* to sendAndReceive. Send-only means that as soon as the Message is created and passed to the
|
||||
* {@link #setRequestChannel(org.springframework.integration.MessageChannel) request channel}, a response will be
|
||||
* generated. Subclasses determine how that response is generated (e.g. simple status response or rendering a View).
|
||||
* <p/>
|
||||
* <p>
|
||||
* In a request-reply scenario, the reply Message's payload will be extracted prior to generating a response by default.
|
||||
* To have the entire serialized Message available for the response, switch the {@link #extractReplyPayload} value to
|
||||
* <code>false</code>.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2002-2010 the original author or authors.
|
||||
* Copyright 2002-2013 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -42,16 +42,16 @@ import org.springframework.web.HttpRequestHandler;
|
||||
* same name. If the {@link #expectReply} property is set to true, a response can generated from a reply Message.
|
||||
* Otherwise, the gateway will play the role of a unidirectional Channel Adapter with a simple status-based response
|
||||
* (e.g. 200 OK).
|
||||
* <p/>
|
||||
* <p>
|
||||
* The default supported request methods are GET and POST, but the list of values can be configured with the
|
||||
* {@link #supportedMethods} property. The payload generated from a GET request (or HEAD or OPTIONS if supported) will
|
||||
* be a {@link MultiValueMap} containing the parameter values. For a request containing a body (e.g. a POST), the type
|
||||
* of the payload is determined by the {@link #setRequestPayloadType(Class) request payload type}.
|
||||
* <p/>
|
||||
* <p>
|
||||
* If the HTTP request is a multipart and a "multipartResolver" bean has been defined in the context, then it will be
|
||||
* converted by the {@link MultipartAwareFormHttpMessageConverter} as long as the default message converters have not
|
||||
* been overwritten (although providing a customized instance of the Multipart-aware converter is also an option).
|
||||
* <p/>
|
||||
* <p>
|
||||
* By default a number of {@link HttpMessageConverter}s are already configured. The list can be overridden by calling
|
||||
* the {@link #setMessageConverters(List)} method.
|
||||
*
|
||||
|
||||
@@ -51,8 +51,8 @@ import com.sun.net.httpserver.HttpServer;
|
||||
* @author Gary Russell
|
||||
* @since 2.2
|
||||
*
|
||||
* <p/>
|
||||
* see https://jira.springsource.org/browse/INT-2397
|
||||
* <p>
|
||||
* see https://jira.springsource.org/browse/INT-2397
|
||||
*/
|
||||
@ContextConfiguration
|
||||
@RunWith(SpringJUnit4ClassRunner.class)
|
||||
|
||||
Reference in New Issue
Block a user