Skip to content
This repository was archived by the owner on Jul 31, 2022. It is now read-only.

Commit 092b109

Browse files
committed
Cleaned up documentation
1 parent be8d868 commit 092b109

File tree

3 files changed

+4
-31
lines changed

3 files changed

+4
-31
lines changed

src/main/java/com/kttdevelopment/simplehttpserver/SimpleHttpExchange.java

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,7 @@
1313
* <i>This class is a simplified implementation of {@link HttpExchange}</i>. <br>
1414
* This class provides methods to process requests from the client and send a response back. The handler will keep executing until a response is sent.<br><br>
1515
* Get/post type requests for <code>application/x-www-form-urlencoded</code> (default) will be a simple key/value map. <br>
16-
* Get/post type requests for <code>multipart/form-data</code> will use an expanded map. <br>
17-
* Example:
18-
* <pre>
19-
* {
20-
* "name_of_key" : {
21-
* "headers": { },
22-
* "value": ""
23-
* },
24-
* "name_of_file_key": {
25-
* "headers": {
26-
* "Content-Disposition": {
27-
* "header-name": "Content-Disposition",
28-
* "header-value": "form-data",
29-
* "parameters": {
30-
* "filename": "file.txt",
31-
* "name": "file"
32-
* }
33-
* },
34-
* "Content-Type": {
35-
* "header-name": "Content-Type",
36-
* "header-value": "text/plain",
37-
* "parameters": {}
38-
* }
39-
* },
40-
* "value": "value in bytes"
41-
* }
42-
* }
43-
* </pre>
16+
* Get/post type requests for <code>multipart/form-data</code> will use a {@link MultipartFormData}. <br>
4417
* If a file is submitted the value will be in bytes unless it is plain text.
4518
*
4619
* @see HttpExchange
@@ -242,7 +215,7 @@ static SimpleHttpExchange create(final HttpExchange exchange){
242215
* @return POST request as a string
243216
*
244217
* @see HttpExchange#getRequestBody()
245-
* @see #getPostMap(
218+
* @see #getPostMap()
246219
* @see #getMultipartFormData()
247220
* @see #hasPost()
248221
* @since 02.00.00

src/main/java/com/kttdevelopment/simplehttpserver/handler/ByteLoadingOption.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*
66
* <code>PRELOAD</code> - read file when it is added to the handler <br>
77
* <code>MODLOAD</code> - read file when it is added and anytime it is updated <br>
8-
* <code>CACHELOAD</code> - load file when requested and clear from memory when maximum time expires <br>
8+
* <code>CACHELOAD</code> - load file when requested and clear from memory when maximum time expires. Requires a {@link CacheFileAdapter}. <br>
99
* <code>LIVELOAD</code> - read file each time an exchange happens
1010
*
1111
* @see FileHandler

src/main/java/com/kttdevelopment/simplehttpserver/handler/CacheFileAdapter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import java.util.concurrent.atomic.AtomicLong;
55

66
/**
7-
* This class caches file bytes when adding to the {@link FileHandler}.
7+
* This class caches file bytes when adding to the {@link FileHandler}. Only works for files withe the {@link ByteLoadingOption#CACHELOAD} option.
88
*
99
* @see FileHandlerAdapter
1010
* @see FileHandler

0 commit comments

Comments
 (0)