Skip to content

Commit f614023

Browse files
Fixing Javadoc typos
1 parent 607d50b commit f614023

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

src/main/java/com/mgnt/lifecycle/management/httpclient/HttpClient.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* The intended use for this class is that for each instance it's state will be set once and will not be changed, and then
3434
* it could be used for multiple HTTP requests that share the same state (same headers and their values, and optionally the
3535
* timeouts and url). If the state of the instance of this class is not changed
36-
* between invocations of method <code>sendHttpRequest</code> then the instance ff this class can be safely used by multiple
36+
* between invocations of method <code>sendHttpRequest</code> then the instance of this class can be safely used by multiple
3737
* threads and thread-safety is guaranteed. The use-case for this class is for repeated calls to predefined URL(s) with the same headers.
3838
* <br><br>Here is an example: Assume that you have some REST API that deals with a "Person" entity. Assume that you have the following
3939
* endpoints:<br>
@@ -57,16 +57,16 @@
5757
* </li>
5858
* <li>
5959
* Extend this class lets say with a Person class that will have the methods <code>get(Long id), update(...),
60-
* create(...), delete() and updateAddress(...) </code>. In constructor for this class pre-set all the
60+
* create(...), delete(Long id) and updateAddress(...) </code>. In constructor for this class pre-set all the
6161
* relevant environment (headers, connection URL) and in the methods mentioned above invoke appropriate
6262
* <code>sendHttpRequest()</code> method. This way the code will look like<br><br>
6363
* <code>
6464
* Person person = new Person();<br>
65-
* person.create(...);<br>
65+
* person.create(person);<br>
6666
* person.updateAddress(...);<br>
6767
* </code><br>
6868
* This will even hide away the fact that the operations are done over Http connection and the code just looks like
69-
* regular code
69+
* regular java code
7070
* </li>
7171
* </ol>
7272
*/

src/main/java/com/mgnt/lifecycle/management/httpclient/ResponseHolder.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55

66
/**
77
* This class contains the actual response data and metadata received upon sending Http Request by {@link HttpClient}
8-
* This class is used as a return type by all versions of <code>sendHttpRequest</code> method of {@link HttpClient} (See for example
8+
* This class is used as a return type by all versions of <code>sendHttpRequest</code> method of {@link HttpClient}. (See for example
99
* {@link HttpClient#sendHttpRequest(String, HttpClient.HttpMethod, String)})
10+
* @since 1.7.0.0
1011
* @param <C> is expected to be either <code>String</code> or <code>ByteBuffer</code> depending on whether the returned data type is
1112
* textual or binary. (See methods {@link HttpClient#sendHttpRequest(String, HttpClient.HttpMethod, String)} and
1213
* {@link HttpClient#sendHttpRequestForBinaryResponse(String, HttpClient.HttpMethod, String)} for example
@@ -69,8 +70,8 @@ public void setResponseHeaders(Map<String, List<String>> responseHeaders) {
6970
/**
7071
*
7172
* @return the content of the response received from server side. The type is expected to be either <code>String</code> or <code>ByteBuffer</code> depending on whether the returned data type is
72-
* * textual or binary. (See methods {@link HttpClient#sendHttpRequest(String, HttpClient.HttpMethod, String)} and
73-
* * {@link HttpClient#sendHttpRequestForBinaryResponse(String, HttpClient.HttpMethod, String)} for example
73+
* textual or binary. (See methods {@link HttpClient#sendHttpRequest(String, HttpClient.HttpMethod, String)} and
74+
* {@link HttpClient#sendHttpRequestForBinaryResponse(String, HttpClient.HttpMethod, String)} for example
7475
*/
7576
public C getResponseContent() {
7677
return responseContent;

0 commit comments

Comments
 (0)