Added javadoc

This commit is contained in:
gmod11
2021-01-05 18:53:14 +01:00
parent bc0ba7ec9f
commit d64acde129
7 changed files with 57 additions and 8 deletions

39
.idea/workspace.xml generated
View File

@@ -19,7 +19,15 @@
<select />
</component>
<component name="ChangeListManager">
<list default="true" id="458cde88-df3d-44bc-9d57-a33823e2f1a6" name="Default Changelist" comment="" />
<list default="true" id="458cde88-df3d-44bc-9d57-a33823e2f1a6" name="Default Changelist" comment="">
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/main/java/com/release11/klaus/config/SwaggerConfig.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/release11/klaus/config/SwaggerConfig.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/main/java/com/release11/klaus/controller/EventController.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/release11/klaus/controller/EventController.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/main/java/com/release11/klaus/controller/KlausController.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/release11/klaus/controller/KlausController.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/main/java/com/release11/klaus/controller/KlausMvcController.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/release11/klaus/controller/KlausMvcController.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/main/java/com/release11/klaus/model/EventRequestDto.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/release11/klaus/model/EventRequestDto.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/main/java/com/release11/klaus/model/MockedMessageDto.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/release11/klaus/model/MockedMessageDto.java" afterDir="false" />
</list>
<option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" />
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
@@ -74,7 +82,7 @@
<property name="com.intellij.testIntegration.createTest.CreateTestDialog.defaultLibrarySuperClass.JUnit5" value="" />
<property name="last_opened_file_path" value="$USER_HOME$/.git/spring-core-spring-mvc" />
<property name="restartRequiresConfirmation" value="false" />
<property name="settings.editor.selected.configurable" value="MavenSettings" />
<property name="settings.editor.selected.configurable" value="preferences.pluginManager" />
</component>
<component name="RecentsManager">
<key name="CreateTestDialog.RecentsKey">
@@ -285,7 +293,12 @@
<option name="presentableId" value="Default" />
<updated>1598862102028</updated>
<workItem from="1609755651686" duration="601000" />
<workItem from="1609767138884" duration="1740000" />
<workItem from="1609767138884" duration="2788000" />
<workItem from="1609777511097" duration="1379000" />
<workItem from="1609843958666" duration="5947000" />
<workItem from="1609858324796" duration="197000" />
<workItem from="1609858548270" duration="300000" />
<workItem from="1609858872909" duration="2771000" />
</task>
<task id="LOCAL-00077" summary="testing jenkins docker">
<created>1601453886631</created>
@@ -681,6 +694,10 @@
<option name="LAST_COMMIT_MESSAGE" value="updating docker files" />
</component>
<component name="WindowStateProjectService">
<state x="304" y="221" width="1559" height="718" key="#Plugins" timestamp="1609858834859">
<screen x="0" y="0" width="1920" height="1160" />
</state>
<state x="304" y="221" width="1559" height="718" key="#Plugins/0.0.1920.1160@0.0.1920.1160" timestamp="1609858834859" />
<state x="2479" y="105" width="1092" height="762" key="#com.intellij.execution.impl.EditConfigurationsDialog" timestamp="1604747761014">
<screen x="1920" y="0" width="1920" height="1040" />
</state>
@@ -715,6 +732,10 @@
<screen x="1920" y="0" width="1920" height="1160" />
</state>
<state x="2610" y="327" key="#com.intellij.refactoring.safeDelete.UnsafeUsagesDialog/0.0.1536.824/1920.0.1920.1160@1920.0.1920.1160" timestamp="1603723877383" />
<state x="490" y="237" key="DBNavigator.ProjectSettingsDialog" timestamp="1609777463956">
<screen x="0" y="0" width="1920" height="1160" />
</state>
<state x="490" y="237" key="DBNavigator.ProjectSettingsDialog/0.0.1920.1160@0.0.1920.1160" timestamp="1609777463956" />
<state x="508" y="128" width="904" height="610" key="EnvironmentVariablesDialog" timestamp="1601384219062">
<screen x="0" y="0" width="1536" height="824" />
</state>
@@ -792,10 +813,11 @@
</state>
<state x="439" y="117" key="NewModule_or_Project.wizard/0.0.1536.824/1920.0.1920.1040@0.0.1536.824" timestamp="1602062762925" />
<state x="439" y="117" key="NewModule_or_Project.wizard/0.0.1536.824@0.0.1536.824" timestamp="1601971581565" />
<state x="277" y="57" key="SettingsEditor" timestamp="1601975962924">
<screen x="0" y="0" width="1536" height="824" />
<state x="833" y="398" key="SettingsEditor" timestamp="1609777945740">
<screen x="0" y="0" width="1920" height="1160" />
</state>
<state x="277" y="57" key="SettingsEditor/0.0.1536.824@0.0.1536.824" timestamp="1601975962923" />
<state x="833" y="398" key="SettingsEditor/0.0.1920.1160@0.0.1920.1160" timestamp="1609777945740" />
<state x="2371" y="183" key="Vcs.Push.Dialog.v2" timestamp="1605864218215">
<screen x="1920" y="0" width="1920" height="1040" />
</state>
@@ -829,10 +851,11 @@
<state x="425" y="187" key="run.anything.popup/0.0.1536.824/1920.0.1920.1040@0.0.1536.824" timestamp="1605787231756" />
<state x="2451" y="236" key="run.anything.popup/0.0.1536.824/1920.0.1920.1040@1920.0.1920.1040" timestamp="1605716394224" />
<state x="425" y="187" key="run.anything.popup/0.0.1536.824@0.0.1536.824" timestamp="1601461825087" />
<state x="2459" y="204" width="840" height="955" key="search.everywhere.popup" timestamp="1603984139797">
<screen x="1920" y="0" width="1920" height="1160" />
<state x="539" y="204" width="840" height="955" key="search.everywhere.popup" timestamp="1609858975773">
<screen x="0" y="0" width="1920" height="1160" />
</state>
<state x="2459" y="204" width="840" height="955" key="search.everywhere.popup/0.0.1536.824/1920.0.1920.1160@1920.0.1920.1160" timestamp="1603984139797" />
<state x="539" y="204" width="840" height="955" key="search.everywhere.popup/0.0.1920.1160@0.0.1920.1160" timestamp="1609858975773" />
</component>
<component name="XDebuggerManager">
<breakpoint-manager>
@@ -852,7 +875,7 @@
</line-breakpoint>
<line-breakpoint enabled="true" type="java-line">
<url>file://$PROJECT_DIR$/src/main/java/com/release11/klaus/controller/KlausController.java</url>
<line>57</line>
<line>62</line>
<option name="timeStamp" value="36" />
</line-breakpoint>
</breakpoints>

View File

@@ -9,6 +9,9 @@ import springfox.documentation.swagger2.annotations.EnableSwagger2;
import static springfox.documentation.builders.PathSelectors.regex;
/**
* Points to swagger version and package containing controller classes
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {

View File

@@ -18,6 +18,10 @@ import java.util.LinkedList;
import java.util.List;
import java.util.UUID;
/**
* Class responds to request asking about history of messages.
*/
@Slf4j
@Controller
@RequestMapping

View File

@@ -22,6 +22,11 @@ import java.util.Map;
import java.util.Objects;
import java.util.UUID;
/**
* A class responds to generated message uri's requests.
* It deletes or fetches the requested message
*/
@Controller("/")
@Slf4j
//@Profile({"DEV", "default"})

View File

@@ -20,6 +20,12 @@ import java.net.InetAddress;
import java.time.LocalDateTime;
import java.util.*;
/**
* Sending GET request to path /home sets up a new UUID ex. 58b9709d-358b-4713-8fbc-6acf89e81418
* UUID is something like session id type which contains references to each saved message
* Next saved massage shares UUID but its id is a +1 ex.
* 58b9709d-358b-4713-8fbc-6acf89e81418/1; 58b9709d-358b-4713-8fbc-6acf89e81418/2 etc.
*/
@Slf4j
@Controller
@RequestMapping

View File

@@ -9,6 +9,9 @@ import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
import java.util.UUID;
/**
* Pojo for client request
*/
@Data
@Builder
@NoArgsConstructor

View File

@@ -8,6 +8,11 @@ import javax.validation.constraints.Positive;
import java.util.Map;
import java.util.UUID;
/**
* it appears that instance of this class contains info about mocked response
* To which UUID it is bound, whats its id, the list of headers, type of content and message body,
* as well as status it has to return.
*/
@Data
@Builder
@ToString