From 421189978602b7cee736a2fca87d9ba12d3b54f0 Mon Sep 17 00:00:00 2001
From: Martin Goik <goik@hdm-stuttgart.de>
Date: Wed, 7 Jan 2015 22:38:24 +0100
Subject: [PATCH] Javadoc correction
---
.../de/hdm_stuttgart/mi/sda1/catalog2sql/DataInsert.java | 7 ++++---
.../de/hdm_stuttgart/mi/sda1/catalog2sql/Helper.java | 9 +++++++++
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/Sda1/P/catalog2rdbms/src/main/java/de/hdm_stuttgart/mi/sda1/catalog2sql/DataInsert.java b/Sda1/P/catalog2rdbms/src/main/java/de/hdm_stuttgart/mi/sda1/catalog2sql/DataInsert.java
index 150f5286d..19fa7f979 100644
--- a/Sda1/P/catalog2rdbms/src/main/java/de/hdm_stuttgart/mi/sda1/catalog2sql/DataInsert.java
+++ b/Sda1/P/catalog2rdbms/src/main/java/de/hdm_stuttgart/mi/sda1/catalog2sql/DataInsert.java
@@ -26,7 +26,6 @@ public class DataInsert {
* lacking age specification.
* @param productId See {@link #insertproduct(String, String, int)}
* @param productName See {@link #insertproduct(String, String, int)}
- * @throws SQLException
*/
public void insertproduct(final String productId, final String productName) {
final String sqlInsertStmt = "INSERT INTO Product (id, name) VALUES ('" + productId + "', '" + productName + "');";
@@ -43,7 +42,6 @@ public class DataInsert {
* @param productId The product's unique id property
* @param productName The product's end user readable name.
* @param age The product's age
- * @throws SQLException
*/
public void insertproduct(final String productId, final String productName, final int age) {
@@ -63,7 +61,6 @@ public class DataInsert {
*
* @param productId The description belongs to this product
* @param descriptions All descriptions belonging to productId
- * @throws SQLException
*/
public void insertDescription(final String productId, final List<String> descriptions) {
@@ -77,6 +74,10 @@ public class DataInsert {
}
}
}
+ /**
+ * Closing internal Statement instance
+ * @throws SQLException
+ */
public void close() throws SQLException {
stmt.close();
}
diff --git a/Sda1/P/catalog2rdbms/src/main/java/de/hdm_stuttgart/mi/sda1/catalog2sql/Helper.java b/Sda1/P/catalog2rdbms/src/main/java/de/hdm_stuttgart/mi/sda1/catalog2sql/Helper.java
index 06e88f12e..b59d33d53 100644
--- a/Sda1/P/catalog2rdbms/src/main/java/de/hdm_stuttgart/mi/sda1/catalog2sql/Helper.java
+++ b/Sda1/P/catalog2rdbms/src/main/java/de/hdm_stuttgart/mi/sda1/catalog2sql/Helper.java
@@ -1,6 +1,15 @@
package de.hdm_stuttgart.mi.sda1.catalog2sql;
+/**
+ * Project wide helper methods
+ *
+ */
public class Helper {
+ /**
+ * Write message to stderr and exit with given error code
+ * @param errMsg
+ * @param errorCode
+ */
public static void exitWithErrorMessage(final String errMsg, int errorCode) {
System.err.println(errMsg);
System.exit(errorCode);
--
GitLab