From 5506bb05002847166924c608959801fd703705a9 Mon Sep 17 00:00:00 2001
From: Martin Goik <goik@hdm-stuttgart.de>
Date: Sun, 7 Dec 2014 18:44:54 +0100
Subject: [PATCH] Jvadoc warnings
---
.../mi/sda1/saxhtml/v1/Memo2Html.java | 66 +++----
.../mi/sda1/saxhtml/v1/Memo2HtmlHandler.java | 165 +++++++++---------
.../mi/sda1/saxhtml/v2/Memo2Html.java | 66 +++----
.../mi/sda1/saxhtml/v2/Memo2HtmlHandler.java | 159 ++++++++---------
.../sda1/saxhtml/v1/test/ConversionTest.java | 3 +-
.../sda1/saxhtml/v2/test/ConversionTest.java | 13 +-
.../de/testing/dom/AssertXpathResult.java | 15 +-
.../de/testing/dom/DomAssert.java | 29 ++-
8 files changed, 283 insertions(+), 233 deletions(-)
diff --git a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v1/Memo2Html.java b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v1/Memo2Html.java
index d5e88368e..1e0d749a6 100644
--- a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v1/Memo2Html.java
+++ b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v1/Memo2Html.java
@@ -12,34 +12,40 @@ import org.xml.sax.XMLReader;
/** Parser, content- and error handler assembly */
public class Memo2Html {
-
- private final XMLReader xmlReader;
- private final Memo2HtmlHandler eventHandler;
- private final MyErrorHandler errorHandler = new MyErrorHandler();
-
- /**
- * @throws SAXException Parsing may fail.
- * @throws ParserConfigurationException Unable to instantiate parser.
- */
- public Memo2Html(final PrintStream out)
- throws SAXException, ParserConfigurationException{
- final SAXParserFactory saxPf = SAXParserFactory.newInstance();
- final SAXParser saxParser = saxPf.newSAXParser();
- xmlReader = saxParser.getXMLReader();
-
- eventHandler = new Memo2HtmlHandler(out);
- xmlReader.setContentHandler(eventHandler);
- xmlReader.setErrorHandler(errorHandler);
- }
-
-
- /** Parse an existing memo instance and create HTML output.
- * @param uri The resource to be parsed
- * @throws IOException Access related problems
- * @throws SAXException Parsing may fail
- */
- public void parse(final String uri)
- throws IOException, SAXException{
- xmlReader.parse(uri);
- }
+
+ private final XMLReader xmlReader;
+ private final Memo2HtmlHandler eventHandler;
+ private final MyErrorHandler errorHandler = new MyErrorHandler();
+
+ /**
+ * @param out
+ * @throws SAXException
+ * Parsing may fail.
+ * @throws ParserConfigurationException
+ * Unable to instantiate parser.
+ */
+ public Memo2Html(final PrintStream out) throws SAXException,
+ ParserConfigurationException {
+ final SAXParserFactory saxPf = SAXParserFactory.newInstance();
+ final SAXParser saxParser = saxPf.newSAXParser();
+ xmlReader = saxParser.getXMLReader();
+
+ eventHandler = new Memo2HtmlHandler(out);
+ xmlReader.setContentHandler(eventHandler);
+ xmlReader.setErrorHandler(errorHandler);
+ }
+
+ /**
+ * Parse an existing memo instance and create HTML output.
+ *
+ * @param uri
+ * The resource to be parsed
+ * @throws IOException
+ * Access related problems
+ * @throws SAXException
+ * Parsing may fail
+ */
+ public void parse(final String uri) throws IOException, SAXException {
+ xmlReader.parse(uri);
+ }
}
\ No newline at end of file
diff --git a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v1/Memo2HtmlHandler.java b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v1/Memo2HtmlHandler.java
index 2b4cd7036..69226b80b 100644
--- a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v1/Memo2HtmlHandler.java
+++ b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v1/Memo2HtmlHandler.java
@@ -12,87 +12,86 @@ import org.xml.sax.helpers.DefaultHandler;
*/
public class Memo2HtmlHandler extends DefaultHandler {
- private final PrintStream out;
- public Memo2HtmlHandler(final PrintStream out) {
- this.out = out;
- }
- boolean printCharacters = false;
-
- @Override public void startDocument() throws SAXException {
-
- out.print("<html>"
- + "\n <head>"
- + "\n <title>Memo message</title>"
- + "\n </head>"
- + "\n <body>"
- );
- }
-
- @Override
- public void startElement(String uri, String localName, String tagName,
- Attributes attributes) throws SAXException {
- switch (tagName) {
- case "from":
- out.print("\n <h2>Message from <strong>");
- printCharacters = true;
- break;
-
- case "to":
- printCharacters = true;
- out.print(" <li>");
- break;
-
- case "subject":
- printCharacters = true;
- out.print(" </ul>"
- + "\n <h2>Subject: ");
- break;
-
- case "content":
- printCharacters = true;
- out.print("\n <p>");
- break;
- }
- }
-
- @Override
- public void characters(char[] ch, int start, int length) throws SAXException {
- if (printCharacters) {
- out.print(new String(ch, start, length));
- }
- }
-
- @Override
- public void endElement(String uri, String localName, String tagName)
- throws SAXException {
- printCharacters = false;
- switch(tagName) {
-
- case "from":
- out.println("</strong></h2>"
- + "\n <h2>Recipients:</h2>"
- + "\n <ul>"
- );
- break;
-
- case "to":
- out.println("</li>");
- break;
-
- case "subject":
- out.print("</h2>");
- break;
-
- case "content":
- out.print("</p>");
- break;
-}
- }
-
- @Override public void endDocument() throws SAXException {
- out.println("\n </body>"
- + "\n</html>"
- );
- out.flush();
- }
+ private final PrintStream out;
+
+ /**
+ * @param out
+ */
+ public Memo2HtmlHandler(final PrintStream out) {
+ this.out = out;
+ }
+
+ boolean printCharacters = false;
+
+ @Override
+ public void startDocument() throws SAXException {
+
+ out.print("<html>" + "\n <head>" + "\n <title>Memo message</title>"
+ + "\n </head>" + "\n <body>");
+ }
+
+ @Override
+ public void startElement(String uri, String localName, String tagName,
+ Attributes attributes) throws SAXException {
+ switch (tagName) {
+ case "from":
+ out.print("\n <h2>Message from <strong>");
+ printCharacters = true;
+ break;
+
+ case "to":
+ printCharacters = true;
+ out.print(" <li>");
+ break;
+
+ case "subject":
+ printCharacters = true;
+ out.print(" </ul>" + "\n <h2>Subject: ");
+ break;
+
+ case "content":
+ printCharacters = true;
+ out.print("\n <p>");
+ break;
+ }
+ }
+
+ @Override
+ public void characters(char[] ch, int start, int length)
+ throws SAXException {
+ if (printCharacters) {
+ out.print(new String(ch, start, length));
+ }
+ }
+
+ @Override
+ public void endElement(String uri, String localName, String tagName)
+ throws SAXException {
+ printCharacters = false;
+ switch (tagName) {
+
+ case "from":
+ out.println("</strong></h2>" + "\n <h2>Recipients:</h2>"
+ + "\n <ul>");
+ break;
+
+ case "to":
+ out.println("</li>");
+ break;
+
+ case "subject":
+ out.print("</h2>");
+ break;
+
+ case "content":
+ out.print("</p>");
+ break;
+ }
+ }
+
+ @Override
+ public void endDocument() throws SAXException {
+ out.println("\n </body>" + "\n</html>");
+ out.flush();
+ }
}
\ No newline at end of file
diff --git a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v2/Memo2Html.java b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v2/Memo2Html.java
index 1f7b1485c..5d0dcf1ba 100644
--- a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v2/Memo2Html.java
+++ b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v2/Memo2Html.java
@@ -14,34 +14,40 @@ import de.hdm_stuttgart.mi.sda1.saxhtml.v1.MyErrorHandler;
/** Parser, content- and error handler assembly */
public class Memo2Html {
-
- private final XMLReader xmlReader;
- private final Memo2HtmlHandler eventHandler;
- private final MyErrorHandler errorHandler = new MyErrorHandler();
-
- /**
- * @throws SAXException Parsing may fail.
- * @throws ParserConfigurationException Unable to instantiate parser.
- */
- public Memo2Html(final PrintStream out)
- throws SAXException, ParserConfigurationException{
- final SAXParserFactory saxPf = SAXParserFactory.newInstance();
- final SAXParser saxParser = saxPf.newSAXParser();
- xmlReader = saxParser.getXMLReader();
-
- eventHandler = new Memo2HtmlHandler(out);
- xmlReader.setContentHandler(eventHandler);
- xmlReader.setErrorHandler(errorHandler);
- }
-
-
- /** Parse an existing memo instance and create HTML output.
- * @param uri The resource to be parsed
- * @throws IOException Access related problems
- * @throws SAXException Parsing may fail
- */
- public void parse(final String uri)
- throws IOException, SAXException{
- xmlReader.parse(uri);
- }
+
+ private final XMLReader xmlReader;
+ private final Memo2HtmlHandler eventHandler;
+ private final MyErrorHandler errorHandler = new MyErrorHandler();
+
+ /**
+ * @param out Write output to stream
+ * @throws SAXException
+ * Parsing may fail.
+ * @throws ParserConfigurationException
+ * Unable to instantiate parser.
+ */
+ public Memo2Html(final PrintStream out) throws SAXException,
+ ParserConfigurationException {
+ final SAXParserFactory saxPf = SAXParserFactory.newInstance();
+ final SAXParser saxParser = saxPf.newSAXParser();
+ xmlReader = saxParser.getXMLReader();
+
+ eventHandler = new Memo2HtmlHandler(out);
+ xmlReader.setContentHandler(eventHandler);
+ xmlReader.setErrorHandler(errorHandler);
+ }
+
+ /**
+ * Parse an existing memo instance and create HTML output.
+ *
+ * @param uri
+ * The resource to be parsed
+ * @throws IOException
+ * Access related problems
+ * @throws SAXException
+ * Parsing may fail
+ */
+ public void parse(final String uri) throws IOException, SAXException {
+ xmlReader.parse(uri);
+ }
}
\ No newline at end of file
diff --git a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v2/Memo2HtmlHandler.java b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v2/Memo2HtmlHandler.java
index 41b5ec5d3..d71670297 100644
--- a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v2/Memo2HtmlHandler.java
+++ b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/main/java/de/hdm_stuttgart/mi/sda1/saxhtml/v2/Memo2HtmlHandler.java
@@ -14,83 +14,84 @@ import org.xml.sax.helpers.DefaultHandler;
*/
public class Memo2HtmlHandler extends DefaultHandler {
- private final PrintStream out;
- public Memo2HtmlHandler(final PrintStream out) {
- this.out = out;
- }
-
- String from, subject, content;
- final List<String> recipients= new Vector<String>();
- final StringBuffer buffer = new StringBuffer();
-
- @Override public void startDocument() throws SAXException {
- // Clear
- recipients.clear();
- }
-
- @Override
- public void startElement(String uri, String localName, String tagName,
- Attributes attributes) throws SAXException {
- buffer.setLength(0); // Clear string buffer
- }
-
- @Override
- public void characters(char[] ch, int start, int length) throws SAXException {
- buffer.append(ch, start, length);
- }
-
- @Override
- public void endElement(String uri, String localName, String tagName)
- throws SAXException {
- switch(tagName) {
-
- case "from":
- from = buffer.toString();
- break;
-
- case "to":
- recipients.add(buffer.toString());
- break;
-
- case "subject":
- subject = buffer.toString();
- break;
-
- case "content":
- content = buffer.toString();
- break;
-}
- }
-
- @Override public void endDocument() throws SAXException {
- // First portion until sender
- out.print
- ( "<html>\n" // xmlns='http://www.w3.org/1999/xhtml'
- + " <head><title>Memo from " + from + "</title></head>\n"
- + " <body>\n"
- + " <h2>Subject:" + subject + "</h2>\n"
- + " <dl>\n"
- + " <dt>Sender:</dt>\n"
- + " <dd>" + from + "</dd>\n"
- + " <dt>Recipients:</dt>\n"
- + " <dd>\n"
- + " <ul>\n");
-
- // Recipients
- for(final String recipient: recipients) {
- out.print
- ( " <li>" + recipient + "</li>\n");
- }
- // Tail including reference to sender
- out.print
- ( " </ul>\n"
- + " </dd>\n"
- + " </dl>\n"
- + " <h2>Subject: " + subject + "</h2>\n"
- + " <p>" + content + "</p>\n"
- + " <p>End of message from <strong>" + from +"</strong></p>\n"
- + " </body>\n"
- + "</html>\n");
- out.flush();
- }
+ private final PrintStream out;
+
+ /**
+ * @param out
+ * Write output to stream
+ */
+ public Memo2HtmlHandler(final PrintStream out) {
+ this.out = out;
+ }
+
+ String from, subject, content;
+ final List<String> recipients = new Vector<String>();
+ final StringBuffer buffer = new StringBuffer();
+
+ @Override
+ public void startDocument() throws SAXException {
+ // Clear
+ recipients.clear();
+ }
+
+ @Override
+ public void startElement(String uri, String localName, String tagName,
+ Attributes attributes) throws SAXException {
+ buffer.setLength(0); // Clear string buffer
+ }
+
+ @Override
+ public void characters(char[] ch, int start, int length)
+ throws SAXException {
+ buffer.append(ch, start, length);
+ }
+
+ @Override
+ public void endElement(String uri, String localName, String tagName)
+ throws SAXException {
+ switch (tagName) {
+
+ case "from":
+ from = buffer.toString();
+ break;
+
+ case "to":
+ recipients.add(buffer.toString());
+ break;
+
+ case "subject":
+ subject = buffer.toString();
+ break;
+
+ case "content":
+ content = buffer.toString();
+ break;
+ }
+ }
+
+ @Override
+ public void endDocument() throws SAXException {
+ // First portion until sender
+ out.print("<html>\n" // xmlns='http://www.w3.org/1999/xhtml'
+ + " <head><title>Memo from " + from
+ + "</title></head>\n"
+ + " <body>\n" + " <h2>Subject:" + subject
+ + "</h2>\n"
+ + " <dl>\n" + " <dt>Sender:</dt>\n"
+ + " <dd>"
+ + from + "</dd>\n"
+ + " <dt>Recipients:</dt>\n"
+ + " <dd>\n" + " <ul>\n");
+
+ // Recipients
+ for (final String recipient : recipients) {
+ out.print(" <li>" + recipient + "</li>\n");
+ }
+ // Tail including reference to sender
+ out.print(" </ul>\n" + " </dd>\n" + " </dl>\n"
+ + " <h2>Subject: " + subject + "</h2>\n" + " <p>"
+ + content + "</p>\n" + " <p>End of message from <strong>"
+ + from + "</strong></p>\n" + " </body>\n" + "</html>\n");
+ out.flush();
+ }
}
\ No newline at end of file
diff --git a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/sda1/saxhtml/v1/test/ConversionTest.java b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/sda1/saxhtml/v1/test/ConversionTest.java
index 7bfa2b14d..c4b3c305d 100644
--- a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/sda1/saxhtml/v1/test/ConversionTest.java
+++ b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/sda1/saxhtml/v1/test/ConversionTest.java
@@ -18,9 +18,10 @@ import de.hdm_stuttgart.mi.sda1.saxhtml.v1.Memo2Html;
/**
* Unit testing XML to HTML output
*/
+@SuppressWarnings("javadoc")
public class ConversionTest {
- public final static String
+ final static String
xmlInputFileName = "src/main/resources/memo.xml",
htmlOutputFileName = xmlInputFileName + ".1.html";
diff --git a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/sda1/saxhtml/v2/test/ConversionTest.java b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/sda1/saxhtml/v2/test/ConversionTest.java
index c6331557f..4c0467f29 100644
--- a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/sda1/saxhtml/v2/test/ConversionTest.java
+++ b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/sda1/saxhtml/v2/test/ConversionTest.java
@@ -18,15 +18,22 @@ import de.hdm_stuttgart.mi.sda1.saxhtml.v2.Memo2Html;
/**
* Unit testing XML to HTML output
*/
+@SuppressWarnings("javadoc")
public class ConversionTest {
- public final static String
+ final static String
xmlInputFileName = "src/main/resources/memo.xml",
htmlOutputFileName = xmlInputFileName + ".2.html";
static Element htmlRootElement;
- @BeforeClass public static void init()
+ /**
+ * @throws JDOMException
+ * @throws SAXException
+ * @throws ParserConfigurationException
+ * @throws IOException
+ */
+@BeforeClass public static void init()
throws JDOMException, SAXException, ParserConfigurationException, IOException {
final PrintStream out = new PrintStream(htmlOutputFileName);
@@ -37,7 +44,7 @@ public class ConversionTest {
out.close();
}
- @Test public void testSenderInHeader() {
+@Test public void testSenderInHeader() {
DomAssert.assertSingleNodeContent("<title>Memo from M. Goik</title> must be child of <head>", htmlRootElement, "head/title", "Memo from M. Goik");
}
@Test public void testNumberfRecipients() {
diff --git a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/testing/dom/AssertXpathResult.java b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/testing/dom/AssertXpathResult.java
index 1a08e5b19..d36d86304 100644
--- a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/testing/dom/AssertXpathResult.java
+++ b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/testing/dom/AssertXpathResult.java
@@ -1,11 +1,18 @@
package de.hdm_stuttgart.de.testing.dom;
+/**
+ * @author goik
+ *
+ */
public class AssertXpathResult extends AssertionError {
- private static final long serialVersionUID = -1369600480719379445L;
+ private static final long serialVersionUID = -1369600480719379445L;
- public AssertXpathResult(String msg) {
- super(msg);
- }
+ /**
+ * @param msg
+ */
+ public AssertXpathResult(String msg) {
+ super(msg);
+ }
}
diff --git a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/testing/dom/DomAssert.java b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/testing/dom/DomAssert.java
index 2e29b3428..02f9ba854 100644
--- a/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/testing/dom/DomAssert.java
+++ b/Sda1/Etest/SaxMemo2Html/SaxMemo2Hhtml_solution/src/test/java/de/hdm_stuttgart/de/testing/dom/DomAssert.java
@@ -6,12 +6,22 @@ import org.jdom2.Element;
import org.jdom2.xpath.XPathExpression;
import org.jdom2.xpath.XPathFactory;
+/**
+ * @author goik
+ *
+ */
public class DomAssert {
final static XPathFactory xpf = XPathFactory.instance();
- public static void assertNumberOfNodes(final String msg, final Element context, final String xpath, int expectedNodeCount) {
+ /**
+ * @param msg
+ * @param context
+ * @param xpath
+ * @param expectedNodeCount
+ */
+public static void assertNumberOfNodes(final String msg, final Element context, final String xpath, int expectedNodeCount) {
@SuppressWarnings({ "unchecked", "rawtypes" })
final XPathExpression<Element> xpathExpr = (XPathExpression<Element>) (XPathExpression) xpf.compile(xpath);
@@ -24,7 +34,13 @@ public class DomAssert {
}
}
- public static void assertSingleNodeContent(final String msg, final Element context, final String xpath, String expectedContent) {
+ /**
+ * @param msg
+ * @param context
+ * @param xpath
+ * @param expectedContent
+ */
+public static void assertSingleNodeContent(final String msg, final Element context, final String xpath, String expectedContent) {
@SuppressWarnings({ "unchecked", "rawtypes" })
final XPathExpression<Element> xpathExpr = (XPathExpression<Element>) (XPathExpression) xpf.compile(xpath);
@@ -40,7 +56,14 @@ public class DomAssert {
}
}
- public static void assertSingleNodeContent(final String msg, final Element context, final String xpath, final String expectedTagName, String expectedContent) {
+ /**
+ * @param msg
+ * @param context
+ * @param xpath
+ * @param expectedTagName
+ * @param expectedContent
+ */
+public static void assertSingleNodeContent(final String msg, final Element context, final String xpath, final String expectedTagName, String expectedContent) {
@SuppressWarnings({ "unchecked", "rawtypes" })
final XPathExpression<Element> xpathExpr = (XPathExpression<Element>) (XPathExpression) xpf.compile(xpath);
--
GitLab