From e9f7817c5f2b31291fe5b40be42264771cd75d7d Mon Sep 17 00:00:00 2001
From: Piotr Gawron <piotr.gawron@uni.lu>
Date: Tue, 8 Jan 2019 10:14:50 +0100
Subject: [PATCH] JavaDoc added
---
.../converter/model/sbml/NotesUtility.java | 25 ++++++++++++++++++-
1 file changed, 24 insertions(+), 1 deletion(-)
diff --git a/converter-sbml/src/main/java/lcsb/mapviewer/converter/model/sbml/NotesUtility.java b/converter-sbml/src/main/java/lcsb/mapviewer/converter/model/sbml/NotesUtility.java
index faf50e7843..d1ca33fbda 100644
--- a/converter-sbml/src/main/java/lcsb/mapviewer/converter/model/sbml/NotesUtility.java
+++ b/converter-sbml/src/main/java/lcsb/mapviewer/converter/model/sbml/NotesUtility.java
@@ -1,5 +1,4 @@
package lcsb.mapviewer.converter.model.sbml;
-
import javax.xml.stream.XMLStreamException;
import org.apache.commons.lang3.StringEscapeUtils;
@@ -7,7 +6,24 @@ import org.sbml.jsbml.AbstractNamedSBase;
import lcsb.mapviewer.converter.InvalidInputDataExecption;
+/**
+ * This utility class parses notes from SBML node and prepares escaped string
+ * ready to use in SBML.
+ *
+ * @author Piotr Gawron
+ *
+ */
public class NotesUtility {
+
+ /**
+ * Extract notes from SBML node
+ *
+ * @param sbmlElement
+ * SBML node
+ * @return notes
+ * @throws InvalidInputDataExecption
+ * thrown when there is problem with extracting notes
+ */
public static String extractNotes(AbstractNamedSBase sbmlElement) throws InvalidInputDataExecption {
String notes = "";
try {
@@ -29,6 +45,13 @@ public class NotesUtility {
return notes;
}
+ /**
+ * Prepares escaped xml string with notes.
+ *
+ * @param notes
+ * notes to be processed
+ * @return escaped xml string with notes
+ */
public static String prepareEscapedXmlNotes(String notes) {
if (notes == null) {
return "";
--
GitLab