Consider adding a doc comment for getAllStudents
77 return users.toString();
78 }
79
80 @RequestMapping(value = "user/getAllStudents", method = RequestMethod.GET) 81 @ResponseBody 82 public String getAllStudents(){ 83 List<Student> students = userHibControl.getAllStudents(); 84 GsonBuilder gson = new GsonBuilder(); 85 gson.registerTypeAdapter(Student.class, new StudentSerializer()); 86 Gson parser = gson.create(); 87 return parser.toJson(students); 88 } 89
90 @RequestMapping(value = "user/getAllModerators", method = RequestMethod.GET)
91 @ResponseBodyConsider adding a doc comment for getAllModerators
87 return parser.toJson(students);
88 }
89
90 @RequestMapping(value = "user/getAllModerators", method = RequestMethod.GET) 91 @ResponseBody 92 public String getAllModerators(){ 93 List<Moderator> moderators = userHibControl.getAllModerators(); 94 GsonBuilder gson = new GsonBuilder(); 95 gson.registerTypeAdapter(Moderator.class, new ModeratorSerializer()); 96 Gson parser = gson.create(); 97 return parser.toJson(moderators); 98 } 99
100 @RequestMapping(value = "user/deleteUser", method = RequestMethod.DELETE)
101 @ResponseBodyConsider adding a doc comment for deleteUser
97 return parser.toJson(moderators);
98 }
99
100 @RequestMapping(value = "user/deleteUser", method = RequestMethod.DELETE)101 @ResponseBody102 public String deleteUser(@RequestParam("id") int id){103 userHibControl.removeUser(id);104 return STATUS_SUCCESS;105 }106
107 @RequestMapping(value = "user/createMod", method = RequestMethod.POST)
108 @ResponseStatus(value = HttpStatus.OK)Consider adding a doc comment for createMod
104 return STATUS_SUCCESS;
105 }
106
107 @RequestMapping(value = "user/createMod", method = RequestMethod.POST)108 @ResponseStatus(value = HttpStatus.OK)109 @ResponseBody110 public String createMod(@RequestBody String request){111 Gson gson = new Gson();112 Properties properties = gson.fromJson(request, Properties.class);113 Moderator mod = new Moderator(properties.getProperty(PROPERTY_LOGIN), properties.getProperty(PROPERTY_PASSWORD), properties.getProperty(PROPERTY_NAME), properties.getProperty(PROPERTY_SURNAME), properties.getProperty(PROPERTY_EMAIL));114 userHibControl.createUser(mod);115 return STATUS_SUCCESS;116 }117
118 @RequestMapping(value = "user/updateStudent", method = RequestMethod.PUT)
119 @ResponseBodyConsider adding a doc comment for updateStudent
115 return STATUS_SUCCESS;
116 }
117
118 @RequestMapping(value = "user/updateStudent", method = RequestMethod.PUT)119 @ResponseBody120 public String updateStudent(@RequestBody String request){121 Gson gson = new Gson();122 Properties properties = gson.fromJson(request, Properties.class);123 Student student = new Student(properties.getProperty(PROPERTY_LOGIN), properties.getProperty(PROPERTY_PASSWORD), properties.getProperty(PROPERTY_NAME), properties.getProperty(PROPERTY_SURNAME), properties.getProperty(PROPERTY_EMAIL), properties.getProperty(PROPERTY_STUDENT_NUMBER));124 userHibControl.editUser(student);125 return STATUS_SUCCESS;126 }127
128 @RequestMapping(value = "user/updateMod", method = RequestMethod.PUT)
129 @ResponseStatus(value = HttpStatus.OK)Consider adding a doc comment for updateMod
125 return STATUS_SUCCESS;
126 }
127
128 @RequestMapping(value = "user/updateMod", method = RequestMethod.PUT)129 @ResponseStatus(value = HttpStatus.OK)130 @ResponseBody131 public String updateMod(@RequestBody String request){132 Gson gson = new Gson();133 Properties properties = gson.fromJson(request, Properties.class);134 Moderator mod = new Moderator(properties.getProperty(PROPERTY_LOGIN), properties.getProperty(PROPERTY_PASSWORD), properties.getProperty(PROPERTY_NAME), properties.getProperty(PROPERTY_SURNAME), properties.getProperty(PROPERTY_EMAIL));135 userHibControl.editUser(mod);136 return STATUS_SUCCESS;137 }138}
Consider adding a doc comment for createStudent
59 else return null;
60 }
61
62 @RequestMapping(value = "user/createStudent", method = RequestMethod.POST) 63 @ResponseStatus(value = HttpStatus.OK) 64 @ResponseBody 65 public String createStudent(@RequestBody String request){ 66 Gson gson = new Gson(); 67 Properties properties = gson.fromJson(request, Properties.class); 68 Student student = new Student(properties.getProperty(PROPERTY_LOGIN), properties.getProperty(PROPERTY_PASSWORD), properties.getProperty(PROPERTY_NAME), properties.getProperty(PROPERTY_SURNAME), properties.getProperty(PROPERTY_EMAIL), properties.getProperty(PROPERTY_STUDENT_NUMBER)); 69 userHibControl.createUser(student); 70 return STATUS_SUCCESS; 71 } 72
73 @RequestMapping(value = "user/getAllUsers", method = RequestMethod.GET)
74 @ResponseBodyConsider adding a doc comment for getUserById
32 SessionFactory factory = new Configuration().configure().buildSessionFactory();
33 UserHibernateController userHibControl = new UserHibernateController(factory);
34
35 @RequestMapping(value = "user/getUser", method = RequestMethod.GET) 36 @ResponseStatus(value = HttpStatus.OK) 37 @ResponseBody 38 public String getUserById(@RequestParam("id") int id){ 39 return userHibControl.getUserById(id).toString(); 40 } 41
42 @RequestMapping(value = "user/userLogin", method = RequestMethod.POST)
43 @ResponseStatus(value = HttpStatus.OK)Consider adding a doc comment for getAllUsers
70 return STATUS_SUCCESS;
71 }
72
73 @RequestMapping(value = "user/getAllUsers", method = RequestMethod.GET) 74 @ResponseBody 75 public String getAllUsers(){ 76 List<User> users = userHibControl.getAllUsers(); 77 return users.toString(); 78 } 79
80 @RequestMapping(value = "user/getAllStudents", method = RequestMethod.GET)
81 @ResponseBodyConsider adding a doc comment for getCurrentUser
39 return userHibControl.getUserById(id).toString();
40 }
41
42 @RequestMapping(value = "user/userLogin", method = RequestMethod.POST) 43 @ResponseStatus(value = HttpStatus.OK) 44 @ResponseBody 45 private String getCurrentUser(@RequestBody String request){ 46 Connection connection = DbUtils.connectToDb(); 47 Gson gson = new Gson(); 48 Properties properties = gson.fromJson(request, Properties.class); 49 User user = userHibControl.getAllUsers().stream().filter(c -> c.getLogin().equals(properties.getProperty(PROPERTY_LOGIN))).filter(c -> c.getPassword().equals(properties.getProperty(PROPERTY_PASSWORD))).findFirst().orElse(null); 50 GsonBuilder gsonBuilder = new GsonBuilder(); 51 if(user instanceof Moderator){ 52 gsonBuilder.registerTypeAdapter(LocalDate.class, new LocalDateSerializer()).registerTypeAdapter(Moderator.class, new ModeratorSerializer()); 53 } 54 else gsonBuilder.registerTypeAdapter(LocalDate.class, new LocalDateSerializer()).registerTypeAdapter(Student.class, new StudentSerializer()); 55 Gson parser = gsonBuilder.create(); 56 DbUtils.disconnectFromDb(connection); 57 if(user != null) 58 return parser.toJson(user); 59 else return null; 60 } 61
62 @RequestMapping(value = "user/createStudent", method = RequestMethod.POST)
63 @ResponseStatus(value = HttpStatus.OK)Consider adding a doc comment for getCourseById
19 SessionFactory factory = new Configuration().configure().buildSessionFactory();
20 FolderHibernateController folderHibControl = new FolderHibernateController(factory);
21
22 @RequestMapping(value = "folder/getFolder", method = RequestMethod.GET)23 @ResponseStatus(value = HttpStatus.OK)24 @ResponseBody25 public String getCourseById(@RequestParam("id") int id){26 return folderHibControl.getFolderById(id).toString();27 }28
29 @RequestMapping(value = "folder/createFolder", method = RequestMethod.POST)
30 @ResponseStatus(value = HttpStatus.OK)Consider adding a doc comment for createFolder
26 return folderHibControl.getFolderById(id).toString();
27 }
28
29 @RequestMapping(value = "folder/createFolder", method = RequestMethod.POST)30 @ResponseStatus(value = HttpStatus.OK)31 @ResponseBody32 public String createFolder(@RequestBody String request){33 Gson gson = new Gson();34 Properties properties = gson.fromJson(request, Properties.class);35 Folder folder = new Folder(properties.getProperty("name"));36 folderHibControl.createFolder(folder);37 return STATUS_SUCCESS;38 }39
40 @RequestMapping(value = "folder/getAllFolders", method = RequestMethod.GET)
41 @ResponseBodyConsider adding a doc comment for getAllFolders
37 return STATUS_SUCCESS;
38 }
39
40 @RequestMapping(value = "folder/getAllFolders", method = RequestMethod.GET)41 @ResponseBody42 public String getAllFolders(){43 List<Folder> folders = folderHibControl.getAllFolders();44 return folders.toString();45 }46
47 @RequestMapping(value = "folder/deleteFolder", method = RequestMethod.DELETE)
48 @ResponseBodyConsider adding a doc comment for deleteFolder
44 return folders.toString();
45 }
46
47 @RequestMapping(value = "folder/deleteFolder", method = RequestMethod.DELETE)48 @ResponseBody49 public String deleteFolder(@RequestParam("id") int id){50 folderHibControl.removeFolder(id);51 return STATUS_SUCCESS;52 }53
54 @RequestMapping(value = "folder/updateFolder", method = RequestMethod.PUT)
55 @ResponseBodyConsider adding a doc comment for updateFolder
51 return STATUS_SUCCESS;
52 }
53
54 @RequestMapping(value = "folder/updateFolder", method = RequestMethod.PUT)55 @ResponseBody56 public String updateFolder(@RequestBody String request){57 Gson gson = new Gson();58 Properties properties = gson.fromJson(request, Properties.class);59 Folder folder = new Folder(properties.getProperty("name"));60 folderHibControl.editFolder(folder);61 return STATUS_SUCCESS;62 }63}
Consider adding a doc comment for getFileById
19 SessionFactory factory = new Configuration().configure().buildSessionFactory();
20 FileHibernateController fileHibControl = new FileHibernateController(factory);
21
22 @RequestMapping(value = "file/getFile", method = RequestMethod.GET)23 @ResponseStatus(value = HttpStatus.OK)24 @ResponseBody25 public String getFileById(@RequestParam("id") int id){26 return fileHibControl.getFileById(id).toString();27 }28
29 @RequestMapping(value = "file/createFile", method = RequestMethod.POST)
30 @ResponseStatus(value = HttpStatus.OK)Consider adding a doc comment for createFile
26 return fileHibControl.getFileById(id).toString();
27 }
28
29 @RequestMapping(value = "file/createFile", method = RequestMethod.POST)30 @ResponseStatus(value = HttpStatus.OK)31 @ResponseBody32 public String createFile(@RequestBody String request){33 Gson gson = new Gson();34 Properties properties = gson.fromJson(request, Properties.class);35 File file = new File(properties.getProperty("name"),properties.getProperty("location"));36 fileHibControl.createFile(file);37 return STATUS_SUCCESS;38 }39
40 @RequestMapping(value = "file/getAllFiles", method = RequestMethod.GET)
41 @ResponseBodyConsider adding a doc comment for getAllFiles
37 return STATUS_SUCCESS;
38 }
39
40 @RequestMapping(value = "file/getAllFiles", method = RequestMethod.GET)41 @ResponseBody42 public String getAllFiles(){43 List<File> files = fileHibControl.getAllFiles();44 return files.toString();45 }46
47 @RequestMapping(value = "file/deleteFile", method = RequestMethod.DELETE)
48 @ResponseBodyConsider adding a doc comment for updateFile
51 return STATUS_SUCCESS;
52 }
53
54 @RequestMapping(value = "file/updateFile", method = RequestMethod.PUT)55 @ResponseBody56 public String updateFile(@RequestBody String request){57 Gson gson = new Gson();58 Properties properties = gson.fromJson(request, Properties.class);59 File file = new File(properties.getProperty("name"),properties.getProperty("location"));60 fileHibControl.editFile(file);61 return STATUS_SUCCESS;62 }63}
Consider adding a doc comment for deleteFile
44 return files.toString();
45 }
46
47 @RequestMapping(value = "file/deleteFile", method = RequestMethod.DELETE)48 @ResponseBody49 public String deleteFile(@RequestParam("id") int id){50 fileHibControl.removeFile(id);51 return STATUS_SUCCESS;52 }53
54 @RequestMapping(value = "file/updateFile", method = RequestMethod.PUT)
55 @ResponseBodyConsider adding a doc comment for getCourseById
23 SessionFactory factory = new Configuration().configure().buildSessionFactory();
24 CourseHibernateController courseHibControl = new CourseHibernateController(factory);
25
26 @RequestMapping(value = "course/getCourse", method = RequestMethod.GET)27 @ResponseStatus(value = HttpStatus.OK)28 @ResponseBody29 public String getCourseById(@RequestParam("id") int id){30 Course course = courseHibControl.getCourseById(id);31 GsonBuilder gson = new GsonBuilder();32 gson.registerTypeAdapter(LocalDate.class, new LocalDateSerializer()).registerTypeAdapter(Course.class, new CourseSerializer());33 Gson parser = gson.create();34 return parser.toJson(course);35 }36
37 @RequestMapping(value = "course/createCourse", method = RequestMethod.POST)
38 @ResponseStatus(value = HttpStatus.OK)Consider adding a doc comment for deleteCourse
55 return parser.toJson(courses);
56 }
57
58 @RequestMapping(value = "course/deleteCourse", method = RequestMethod.DELETE)59 @ResponseBody60 public String deleteCourse(@RequestParam("id") int id){61 courseHibControl.removeCourse(id);62 return STATUS_SUCCESS;63 }64
65 @RequestMapping(value = "course/updateCourse", method = RequestMethod.PUT)
66 @ResponseBodyConsider adding a doc comment for updateCourse
62 return STATUS_SUCCESS;
63 }
64
65 @RequestMapping(value = "course/updateCourse", method = RequestMethod.PUT)66 @ResponseBody67 public String updateCourse(@RequestBody String request){68 Gson gson = new Gson();69 Properties properties = gson.fromJson(request, Properties.class);70 Course course = new Course(Integer.parseInt(properties.getProperty("id")), properties.getProperty("title"), properties.getProperty("description"));71 //, LocalDate.parse(properties.getProperty("startDate")),LocalDate.parse(properties.getProperty("endDate"))72 courseHibControl.editCourse(course);73 return STATUS_SUCCESS;74 }75}
Consider adding a doc comment for getAllCourses
45 return STATUS_SUCCESS;
46 }
47
48 @RequestMapping(value = "course/getAllCourses", method = RequestMethod.GET)49 @ResponseBody50 public String getAllCourses(){51 List<Course> courses = courseHibControl.getAllCourses();52 GsonBuilder gson = new GsonBuilder();53 gson.registerTypeAdapter(Course.class, new CourseSerializer());54 Gson parser = gson.create();55 return parser.toJson(courses);56 }57
58 @RequestMapping(value = "course/deleteCourse", method = RequestMethod.DELETE)
59 @ResponseBodyConsider adding a doc comment for createCourse
34 return parser.toJson(course);
35 }
36
37 @RequestMapping(value = "course/createCourse", method = RequestMethod.POST)38 @ResponseStatus(value = HttpStatus.OK)39 @ResponseBody40 public String createCourse(@RequestBody String request){41 Gson gson = new Gson();42 Properties properties = gson.fromJson(request, Properties.class);43 Course course = new Course(properties.getProperty("title"), properties.getProperty("description"), LocalDate.parse(properties.getProperty("startDate")),LocalDate.parse(properties.getProperty("endDate")));44 courseHibControl.createCourse(course);45 return STATUS_SUCCESS;46 }47
48 @RequestMapping(value = "course/getAllCourses", method = RequestMethod.GET)
49 @ResponseBody
Description
This method does not have any documentation.
Consider adding a documentation comment to explain its use.
While it may seem like the usage of a method is perfectly obvious, any consumers of your API may not be able to pick up on certain details.
Bad Practice
This method appears to return an address string based on its name and the return type, but it is hard to say anything further about it. We neither know if the address will be formatted in a special way nor are we given any useful information regarding the returned value.
String getAddress() {
// ...
}
Recommended
Provide a detailed description of what the method does.
/**
* Returns the address in 3 line format,
* with street address on line 1, area/city on line 2
* and state and country as well as postal code on line 3.
*/
String getAddress() {
// ...
}